4587 add incident id in filter to historic process instance query

engine-rest/engine-rest-openapi/src/main/templates/lib/commons/history-process-instance.ftl

@@ -123,6 +123,12 @@
     "desc": "Only include process instances which have a root incident. Value may only be `true`, as `false` is the default behavior."
   },
 
+  "incidentIdIn": {
+    "type": "array",
+    "itemType": "string",
+    "desc": "Restrict to instances that have an incident with one of the given ids. ${listTypeDescription}"
+  },
+
   "incidentType": {
     "type": "string",
     "desc": "Filter by the incident type. See the [User Guide](${docsUrl}/user-guide/process-engine/incidents/#incident-types) for a list of incident types."

engine-rest/engine-rest/src/main/java/org/camunda/bpm/engine/rest/dto/history/HistoricProcessInstanceQueryDto.java

@@ -114,6 +114,7 @@ public class HistoricProcessInstanceQueryDto extends AbstractQueryDto<HistoricPr
   private Boolean completed;
   private Boolean externallyTerminated;
   private Boolean internallyTerminated;
+  private List<String> incidentIds;
 
   private List<VariableQueryParameterDto> variables;
 
@@ -306,6 +307,11 @@ public void setIncidentType(String incidentType) {
     this.incidentType = incidentType;
   }
 
+  @CamundaQueryParam(value = "incidentIdIn", converter = StringListConverter.class)
+  public void setIncidentIdIn(List<String> incidentIds) {
+    this.incidentIds = incidentIds;
+  }
+
   @CamundaQueryParam(value = "tenantIdIn", converter = StringListConverter.class)
   public void setTenantIdIn(List<String> tenantIds) {
     this.tenantIds = tenantIds;
@@ -443,6 +449,9 @@ protected void applyFilters(HistoricProcessInstanceQuery query) {
     if (withRootIncidents != null && withRootIncidents) {
       query.withRootIncidents();
     }
+    if (incidentIds != null && !incidentIds.isEmpty()) {
+      query.incidentIdIn(incidentIds.toArray(new String[0]));
+    }
     if (incidentStatus != null) {
       query.incidentStatus(incidentStatus);
     }

engine-rest/engine-rest/src/test/java/org/camunda/bpm/engine/rest/history/HistoricProcessInstanceRestServiceQueryTest.java

@@ -73,6 +73,7 @@ public class HistoricProcessInstanceRestServiceQueryTest extends AbstractRestSer
   protected static final String QUERY_PARAM_EXECUTED_ACTIVITY_AFTER = "executedActivityAfter";
   protected static final String QUERY_PARAM_EXECUTED_ACTIVITY_IDS = "executedActivityIdIn";
   protected static final String QUERY_PARAM_ACTIVE_ACTIVITY_IDS = "activeActivityIdIn";
+  protected static final String QUERY_PARAM_INCIDENT_IDS = "incidentIdIn";
 
   @ClassRule
   public static TestContainerRule rule = new TestContainerRule();
@@ -2317,5 +2318,32 @@ public void testQueryByRootProcessInstancesAsPost() {
 
     verify(mockedQuery).rootProcessInstances();
   }
+  @Test
+  public void testQueryByIncidentIdIn() {
+    given()
+        .queryParam(QUERY_PARAM_INCIDENT_IDS, "1,2")
+        .then().expect()
+        .statusCode(Status.OK.getStatusCode())
+        .when()
+        .get(HISTORIC_PROCESS_INSTANCE_RESOURCE_URL);
+
+    verify(mockedQuery).incidentIdIn("1", "2");
+  }
+
+  @Test
+  public void testQueryByIncidentIdInAsPost() {
+    Map<String, List<String>> parameters = new HashMap<String, List<String>>();
+    parameters.put(QUERY_PARAM_INCIDENT_IDS, Arrays.asList("1", "2"));
+
+    given()
+        .contentType(POST_JSON_CONTENT_TYPE)
+        .body(parameters)
+        .then().expect()
+        .statusCode(Status.OK.getStatusCode())
+        .when()
+        .post(HISTORIC_PROCESS_INSTANCE_RESOURCE_URL);
+
+    verify(mockedQuery).incidentIdIn("1", "2");
+  }
 
 }

engine/src/main/java/org/camunda/bpm/engine/history/HistoricProcessInstanceQuery.java

@@ -127,6 +127,11 @@ public interface HistoricProcessInstanceQuery extends Query<HistoricProcessInsta
    */
   HistoricProcessInstanceQuery withRootIncidents();
 
+  /**
+   * Only select historic process instances that have incidents with given ids.
+   */
+  HistoricProcessInstanceQuery incidentIdIn(String... incidentIds);
+
   /**
    * Only select historic process instances with incident status either 'open' or 'resolved'.
    * To get all process instances with incidents, use {@link HistoricProcessInstanceQuery#withIncidents()}.

engine/src/main/java/org/camunda/bpm/engine/impl/HistoricProcessInstanceQueryImpl.java

@@ -92,6 +92,7 @@ public class HistoricProcessInstanceQueryImpl extends AbstractVariableQueryImpl<
   protected String[] executedActivityIds;
   protected String[] activeActivityIds;
   protected String state;
+  protected String[] incidentIds;
 
   protected String caseInstanceId;
 
@@ -179,6 +180,12 @@ public HistoricProcessInstanceQuery withRootIncidents() {
     this.withRootIncidents = true;
     return this;
   }
+
+  public HistoricProcessInstanceQuery incidentIdIn(String... incidentIds) {
+    ensureNotNull("incidentIds", (Object[]) incidentIds);
+    this.incidentIds = incidentIds;
+    return this;
+  }
 
   public HistoricProcessInstanceQuery incidentType(String incidentType) {
     ensureNotNull("incident type", incidentType);
@@ -730,6 +737,10 @@ public String[] getTenantIds() {
     return tenantIds;
   }
 
+  public String[] getIncidentIds() {
+    return incidentIds;
+  }
+
   @Override
   public HistoricProcessInstanceQuery executedActivityAfter(Date date) {
     this.executedActivityAfter = date;

engine/src/main/resources/org/camunda/bpm/engine/impl/mapping/entity/HistoricProcessInstance.xml

@@ -409,7 +409,7 @@
         <bind name="JOIN_TYPE" value="'left join'" />
       </if>
 
-      <if test="query != null &amp;&amp; (query.withIncidents || query.withRootIncidents || query.incidentStatus != null || query.incidentMessage != null || query.incidentMessageLike != null || query.incidentType != null)">
+      <if test="query != null &amp;&amp; (query.withIncidents || query.withRootIncidents || query.incidentStatus != null || query.incidentMessage != null || query.incidentMessageLike != null || query.incidentType != null || (incidentIds != null &amp;&amp; incidentIds.length > 0))">
         <bind name="INC_JOIN" value="true" />
       </if>
 
@@ -553,6 +553,14 @@
             <if test="query.incidentType != null">
               ${queryType} INC.INCIDENT_TYPE_ = #{query.incidentType}
             </if>
+
+            <if test="query.incidentIds != null &amp;&amp; query.incidentIds.length > 0">
+              ${queryType} INC.ID_ IN
+              <foreach item="incidentId" index="index" collection="query.incidentIds" open="(" separator="," close=")">
+                  #{incidentId}
+              </foreach>
+            </if>
+
             <if test="query.incidentMessage != null">
               ${queryType} INC.INCIDENT_MSG_ = #{query.incidentMessage}
             </if>

engine/src/test/java/org/camunda/bpm/engine/test/history/HistoricProcessInstanceTest.java

@@ -39,6 +39,7 @@
 import java.util.List;
 import java.util.Map;
 
+import java.util.stream.Collectors;
 import org.apache.commons.lang3.time.DateUtils;
 import org.camunda.bpm.engine.BadUserRequestException;
 import org.camunda.bpm.engine.CaseService;
@@ -59,6 +60,7 @@
 import org.camunda.bpm.engine.impl.history.event.HistoricProcessInstanceEventEntity;
 import org.camunda.bpm.engine.impl.util.ClockUtil;
 import org.camunda.bpm.engine.repository.ProcessDefinition;
+import org.camunda.bpm.engine.runtime.Incident;
 import org.camunda.bpm.engine.runtime.Job;
 import org.camunda.bpm.engine.runtime.ProcessInstance;
 import org.camunda.bpm.engine.task.Task;
@@ -1693,6 +1695,100 @@ public void testQueryByMultipleInvalidProcessDefinitionKeyIn() {
     }
   }
 
+  @Test
+  @RequiredHistoryLevel(ProcessEngineConfiguration.HISTORY_FULL)
+  @Deployment(resources={"org/camunda/bpm/engine/test/api/runtime/failingProcessCreateOneIncident.bpmn20.xml"})
+  public void shouldQueryProcessInstancesWithIncidentIdIn() {
+    // GIVEN
+    ProcessInstance processInstance = runtimeService.startProcessInstanceByKey("failingProcess");
+    ProcessInstance processInstance2 = runtimeService.startProcessInstanceByKey("failingProcess");
+    runtimeService.startProcessInstanceByKey("failingProcess");
+    List<String> queriedProcessInstances = Arrays.asList(processInstance.getId(), processInstance2.getId());
+
+    testHelper.executeAvailableJobs();
+    Incident incident = runtimeService.createIncidentQuery().processInstanceId(queriedProcessInstances.get(0)).singleResult();
+    Incident incident2 = runtimeService.createIncidentQuery().processInstanceId(queriedProcessInstances.get(1)).singleResult();
+
+    // WHEN
+    List<HistoricProcessInstance> processInstanceList =
+        historyService.createHistoricProcessInstanceQuery().incidentIdIn(incident.getId(), incident2.getId()).list();
+
+    // THEN
+    assertEquals(2, processInstanceList.size());
+    assertThat(queriedProcessInstances)
+        .containsExactlyInAnyOrderElementsOf(
+            processInstanceList.stream()
+                .map(HistoricProcessInstance::getId)
+                .collect(Collectors.toList()));
+  }
+
+  @Test
+  @RequiredHistoryLevel(ProcessEngineConfiguration.HISTORY_FULL)
+  @Deployment(resources={"org/camunda/bpm/engine/test/api/runtime/failingProcessAfterUserTaskCreateOneIncident.bpmn20.xml"})
+  public void shouldOnlyQueryProcessInstancesWithIncidentIdIn() {
+    // GIVEN
+    ProcessInstance processWithIncident1 = runtimeService.startProcessInstanceByKey("failingProcess");
+    ProcessInstance processWithIncident2 = runtimeService.startProcessInstanceByKey("failingProcess");
+
+    List<Task> tasks = taskService.createTaskQuery().list();
+    assertEquals(2, tasks.size());
+    taskService.complete(tasks.get(0).getId());
+    taskService.complete(tasks.get(1).getId());
+
+    ProcessInstance processWithoutIncident = runtimeService.startProcessInstanceByKey("failingProcess");
+
+    List<String> queriedProcessInstances = Arrays.asList(processWithIncident1.getId(), processWithIncident2.getId());
+
+    testHelper.executeAvailableJobs();
+    Incident incident = runtimeService.createIncidentQuery().processInstanceId(queriedProcessInstances.get(0)).singleResult();
+    Incident incident2 = runtimeService.createIncidentQuery().processInstanceId(queriedProcessInstances.get(1)).singleResult();
+
+    // WHEN
+    List<HistoricProcessInstance> processInstanceList =
+        historyService.createHistoricProcessInstanceQuery().incidentIdIn(incident.getId(), incident2.getId()).list();
+
+    // THEN
+    assertEquals(2, processInstanceList.size());
+    assertThat(queriedProcessInstances)
+        .containsExactlyInAnyOrderElementsOf(
+            processInstanceList.stream()
+                .map(HistoricProcessInstance::getId)
+                .collect(Collectors.toList()));
+  }
+
+  @Test
+  public void shouldFailWhenQueryWithNullIncidentIdIn() {
+    try {
+      historyService.createHistoricProcessInstanceQuery().incidentIdIn(null).list();
+      fail("incidentMessage with null value is not allowed");
+    } catch( NullValueException nex ) {
+      // expected
+    }
+  }
+
+  @Test
+  @RequiredHistoryLevel(ProcessEngineConfiguration.HISTORY_FULL)
+  @Deployment(resources={"org/camunda/bpm/engine/test/api/runtime/failingSubProcessCreateOneIncident.bpmn20.xml"})
+  public void shouldQueryByIncidentIdInSubProcess() {
+    // given
+    ProcessInstance processInstance = runtimeService.startProcessInstanceByKey("failingSubProcess");
+
+    testHelper.executeAvailableJobs();
+
+    List<Incident> incidentList = runtimeService.createIncidentQuery().list();
+    assertEquals(1, incidentList.size());
+
+    Incident incident = runtimeService.createIncidentQuery().processInstanceId(processInstance.getId()).singleResult();
+
+    // when
+    HistoricProcessInstance historicPI =
+        historyService.createHistoricProcessInstanceQuery().incidentIdIn(incident.getId()).singleResult();
+
+    // then
+    assertThat(historicPI).isNotNull();
+    assertThat(historicPI.getId()).isEqualTo(processInstance.getId());
+  }
+
   @Test
   @Deployment(resources = {"org/camunda/bpm/engine/test/history/oneAsyncTaskProcess.bpmn20.xml"})
   public void testShouldStoreHistoricProcessInstanceVariableOnAsyncBefore() {

engine/src/test/resources/org/camunda/bpm/engine/test/api/runtime/failingProcessAfterUserTaskCreateOneIncident.bpmn20.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<definitions xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL"
+             xmlns:camunda="http://camunda.org/schema/1.0/bpmn"
+             targetNamespace="Examples">
+
+  <process id="failingProcess" name="Failing Process" isExecutable="true">
+
+    <startEvent id="start" />
+    <sequenceFlow id="flow1" sourceRef="start" targetRef="userTask" />
+    <userTask id="userTask" />
+    <sequenceFlow id="flow2" sourceRef="userTask" targetRef="serviceTask" />
+    <serviceTask id="serviceTask" camunda:async="true"
+                 camunda:class="org.camunda.bpm.engine.test.api.runtime.FailingDelegate" name="Service Task"/>
+    <sequenceFlow id="flow3" sourceRef="serviceTask" targetRef="end" />
+    <endEvent id="end" />
+
+  </process>
+
+</definitions>