Add support for empty states and types for plan item instance query

Author: tijsrademakers

modules/flowable-cmmn-engine/src/main/java/org/flowable/cmmn/engine/impl/persistence/entity/data/impl/MybatisPlanItemInstanceDataManagerImpl.java

@@ -219,8 +219,8 @@ public boolean isRetained(PlanItemInstanceEntity entity, Object param) {
             boolean ended = (boolean) map.get("ended");
 
             return caseInstanceId.equals(entity.getCaseInstanceId())
-                    && planItemDefinitionTypes.contains(entity.getPlanItemDefinitionType())
-                    && states.contains(entity.getState())
+                    && (planItemDefinitionTypes == null || planItemDefinitionTypes.contains(entity.getPlanItemDefinitionType()))
+                    && (states == null || states.contains(entity.getState()))
                     && (ended ? entity.getEndedTime() != null : entity.getEndedTime() == null);
         }
 

modules/flowable-cmmn-engine/src/main/resources/org/flowable/cmmn/db/mapping/entity/PlanItemInstance.xml

@@ -372,8 +372,12 @@
   <select id="selectPlanItemInstancesByCaseInstanceIdAndTypeAndState" parameterType="org.flowable.common.engine.impl.db.ListQueryParameterObject" resultMap="planItemInstanceResultMap">
     select * from ${prefix}ACT_CMMN_RU_PLAN_ITEM_INST RES
     where CASE_INST_ID_ = #{parameter.caseInstanceId, jdbcType=VARCHAR}
-    and ITEM_DEFINITION_TYPE_ in <foreach item="planItemDefinitionType" index="index" collection="parameter.planItemDefinitionTypes" open="(" separator="," close=")">#{planItemDefinitionType, jdbcType=VARCHAR}</foreach>
-    and STATE_ in <foreach item="state" index="index" collection="parameter.states" open="(" separator="," close=")">#{state, jdbcType=VARCHAR}</foreach>
+    <if test="parameter.planItemDefinitionTypes != null &amp;&amp; !parameter.planItemDefinitionTypes.empty">
+        and ITEM_DEFINITION_TYPE_ in <foreach item="planItemDefinitionType" index="index" collection="parameter.planItemDefinitionTypes" open="(" separator="," close=")">#{planItemDefinitionType, jdbcType=VARCHAR}</foreach>
+    </if>
+    <if test="parameter.states != null &amp;&amp; !parameter.states.empty">
+        and STATE_ in <foreach item="state" index="index" collection="parameter.states" open="(" separator="," close=")">#{state, jdbcType=VARCHAR}</foreach>
+    </if>
     <if test="parameter.ended">
         and ENDED_TIME_ is not null
     </if>

modules/flowable-cmmn-engine/src/test/java/org/flowable/cmmn/test/runtime/PlanItemInstanceEntityManagerTest.java

@@ -13,30 +13,16 @@
 package org.flowable.cmmn.test.runtime;
 
 import static org.assertj.core.api.Assertions.assertThat;
-import static org.assertj.core.api.Assertions.entry;
-import static org.assertj.core.api.Assertions.tuple;
-import static org.flowable.cmmn.api.runtime.PlanItemInstanceState.ACTIVE;
 
 import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.Date;
 import java.util.List;
 
-import org.flowable.cmmn.api.history.HistoricPlanItemInstance;
-import org.flowable.cmmn.api.runtime.CaseInstance;
 import org.flowable.cmmn.api.runtime.PlanItemDefinitionType;
-import org.flowable.cmmn.api.runtime.PlanItemInstance;
 import org.flowable.cmmn.api.runtime.PlanItemInstanceState;
-import org.flowable.cmmn.api.runtime.UserEventListenerInstance;
-import org.flowable.cmmn.engine.PlanItemLocalizationManager;
 import org.flowable.cmmn.engine.impl.CmmnManagementServiceImpl;
 import org.flowable.cmmn.engine.impl.persistence.entity.PlanItemInstanceEntity;
 import org.flowable.cmmn.engine.impl.util.CommandContextUtil;
-import org.flowable.cmmn.engine.test.CmmnDeployment;
 import org.flowable.cmmn.engine.test.FlowableCmmnTestCase;
-import org.flowable.common.engine.impl.interceptor.Command;
-import org.flowable.common.engine.impl.interceptor.CommandContext;
-import org.flowable.task.api.Task;
 import org.junit.Before;
 import org.junit.Test;
 
@@ -72,6 +58,28 @@ public void testFindByCaseInstanceIdAndTypeAndState() {
 
         assertThat(planItemInstances).hasSize(1);
         assertThat(planItemInstances.get(0).getName()).isEqualTo("B");
+        
+        planItemInstances = ((CmmnManagementServiceImpl) cmmnManagementService).executeCommand(
+                commandContext -> CommandContextUtil.getPlanItemInstanceEntityManager().findByCaseInstanceIdAndTypeAndState(caseInstanceId,
+                        null, List.of(PlanItemInstanceState.ENABLED), false));
+
+        assertThat(planItemInstances).hasSize(1);
+        assertThat(planItemInstances.get(0).getName()).isEqualTo("B");
+        
+        planItemInstances = ((CmmnManagementServiceImpl) cmmnManagementService).executeCommand(
+                commandContext -> CommandContextUtil.getPlanItemInstanceEntityManager().findByCaseInstanceIdAndTypeAndState(caseInstanceId,
+                        null, null, false));
+
+        assertThat(planItemInstances).hasSize(4);
+        List<String> names = new ArrayList<>();
+        for (PlanItemInstanceEntity planItemInstance : planItemInstances) {
+            names.add(planItemInstance.getName());
+        }
+        
+        assertThat(names).contains("A");
+        assertThat(names).contains("B");
+        assertThat(names).contains("Stage one");
+        assertThat(names).contains("Stage two");
     }
 
     private List<String> startInstances(int numberOfInstances) {