Expos plan item instance local variables via query and rest api (#3971)

Co-authored-by: Christopher Welsch <christopher.welsch@flowable.com>

Author: WelschChristopher

modules/flowable-cmmn-api/src/main/java/org/flowable/cmmn/api/history/HistoricPlanItemInstance.java

@@ -13,6 +13,7 @@
 package org.flowable.cmmn.api.history;
 
 import java.util.Date;
+import java.util.Map;
 
 /**
  * @author Dennis Federico
@@ -88,4 +89,6 @@ public interface HistoricPlanItemInstance {
 
     /** Sets an optional localized name for the plan item */
     void setLocalizedName(String localizedName);
+
+    Map<String, Object> getPlanItemInstanceLocalVariables();
 }

modules/flowable-cmmn-api/src/main/java/org/flowable/cmmn/api/history/HistoricPlanItemInstanceQuery.java

@@ -85,6 +85,8 @@ public interface HistoricPlanItemInstanceQuery extends Query<HistoricPlanItemIns
      */
     HistoricPlanItemInstanceQuery withLocalizationFallback();
 
+    HistoricPlanItemInstanceQuery includeLocalVariables();
+
     HistoricPlanItemInstanceQuery orderByCreateTime();
     HistoricPlanItemInstanceQuery orderByEndedTime();
     HistoricPlanItemInstanceQuery orderByLastAvailableTime();

modules/flowable-cmmn-api/src/main/java/org/flowable/cmmn/api/runtime/PlanItemInstance.java

@@ -13,6 +13,7 @@
 package org.flowable.cmmn.api.runtime;
 
 import java.util.Date;
+import java.util.Map;
 
 /**
  * @author Joram Barrez
@@ -58,7 +59,7 @@ default Date getStartTime() {
     String getFormKey();
     String getExtraValue();
     String getTenantId();
-    
+    Map<String, Object> getPlanItemInstanceLocalVariables();
 
     /** Sets an optional localized name for the plan item */
     void setLocalizedName(String localizedName);

modules/flowable-cmmn-api/src/main/java/org/flowable/cmmn/api/runtime/PlanItemInstanceQuery.java

@@ -381,6 +381,12 @@ public interface PlanItemInstanceQuery extends Query<PlanItemInstanceQuery, Plan
      */
     PlanItemInstanceQuery caseVariableNotExists(String name);
 
+    /**
+     *
+     * Include local plan item instance variables in the query result
+     */
+    PlanItemInstanceQuery includeLocalVariables();
+
     /**
      * Localize plan item name to specified locale.
      */

modules/flowable-cmmn-engine/src/main/java/org/flowable/cmmn/engine/impl/delegate/ReadOnlyDelegatePlanItemInstanceImpl.java

@@ -58,6 +58,7 @@ public class ReadOnlyDelegatePlanItemInstanceImpl implements ReadOnlyDelegatePla
     protected final String formKey;
     protected final String extraValue;
     protected final Map<String, Object> variables;
+    protected final Map<String, Object> localVariables;
     protected final String tenantId;
     protected final PlanItem planItem;
 
@@ -94,6 +95,7 @@ public ReadOnlyDelegatePlanItemInstanceImpl(DelegatePlanItemInstance planItemIns
         this.formKey = planItemInstance.getFormKey();
         this.extraValue = planItemInstance.getExtraValue();
         this.variables = new HashMap<>(planItemInstance.getVariables());
+        this.localVariables = new HashMap<>(planItemInstance.getPlanItemInstanceLocalVariables());
         this.tenantId = planItemInstance.getTenantId();
         this.planItem = planItemInstance.getPlanItem();
     }
@@ -268,6 +270,11 @@ public String getTenantId() {
         return tenantId;
     }
 
+    @Override
+    public Map<String, Object> getPlanItemInstanceLocalVariables() {
+        return localVariables;
+    }
+
     @Override
     public PlanItem getPlanItem() {
         return planItem;

modules/flowable-cmmn-engine/src/main/java/org/flowable/cmmn/engine/impl/history/HistoricPlanItemInstanceQueryImpl.java

@@ -88,6 +88,7 @@ public class HistoricPlanItemInstanceQueryImpl extends AbstractQuery<HistoricPla
     protected boolean withoutTenantId;
     protected String locale;
     protected boolean withLocalizationFallback;
+    protected boolean includeLocalVariables;
 
     public HistoricPlanItemInstanceQueryImpl() {
 
@@ -439,6 +440,13 @@ public HistoricPlanItemInstanceQuery withLocalizationFallback() {
         return this;
     }
 
+    @Override
+    public HistoricPlanItemInstanceQuery includeLocalVariables() {
+        this.includeLocalVariables = true;
+        return this;
+    }
+
+
     @Override
     public HistoricPlanItemInstanceQuery orderByCreateTime() {
         return orderBy(HistoricPlanItemInstanceQueryProperty.CREATE_TIME);
@@ -511,7 +519,12 @@ public long executeCount(CommandContext commandContext) {
 
     @Override
     public List<HistoricPlanItemInstance> executeList(CommandContext commandContext) {
-        List<HistoricPlanItemInstance> historicPlanItems = CommandContextUtil.getHistoricPlanItemInstanceEntityManager(commandContext).findByCriteria(this);
+        List<HistoricPlanItemInstance> historicPlanItems;
+        if (includeLocalVariables){
+            historicPlanItems = CommandContextUtil.getHistoricPlanItemInstanceEntityManager(commandContext).findWithVariablesByCriteria(this);
+        } else {
+             historicPlanItems =CommandContextUtil.getHistoricPlanItemInstanceEntityManager(commandContext).findByCriteria(this);
+        }
 
         CmmnEngineConfiguration cmmnEngineConfiguration = CommandContextUtil.getCmmnEngineConfiguration(commandContext);
         if (cmmnEngineConfiguration.getPlanItemLocalizationManager() != null) {
@@ -676,6 +689,9 @@ public String getTenantIdLike() {
     public boolean isWithoutTenantId() {
         return withoutTenantId;
     }
+    public boolean isIncludeLocalVariables() {
+        return includeLocalVariables;
+    }
 
     public List<List<String>> getSafeInvolvedGroups() {
         return safeInvolvedGroups;

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

@@ -13,10 +13,12 @@
 package org.flowable.cmmn.engine.impl.persistence.entity;
 
 import java.util.Date;
+import java.util.List;
 
 import org.flowable.cmmn.api.history.HistoricPlanItemInstance;
 import org.flowable.common.engine.impl.db.HasRevision;
 import org.flowable.common.engine.impl.persistence.entity.Entity;
+import org.flowable.variable.service.impl.persistence.entity.HistoricVariableInstanceEntity;
 
 /**
  * @author Dennis Federico
@@ -91,4 +93,5 @@ public interface HistoricPlanItemInstanceEntity extends Entity, HasRevision, His
 
     void setTenantId(String tenantId);
 
+    List<HistoricVariableInstanceEntity> getQueryVariables();
 }

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

@@ -14,11 +14,16 @@
 
 import java.util.Date;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 
 import org.apache.commons.lang3.StringUtils;
 import org.flowable.cmmn.api.runtime.PlanItemInstance;
 import org.flowable.cmmn.engine.CmmnEngineConfiguration;
+import org.flowable.common.engine.impl.context.Context;
+import org.flowable.variable.api.history.HistoricVariableInstance;
+import org.flowable.variable.service.impl.persistence.entity.HistoricVariableInitializingList;
+import org.flowable.variable.service.impl.persistence.entity.HistoricVariableInstanceEntity;
 
 /**
  * @author Dennis Federico
@@ -57,6 +62,7 @@ public class HistoricPlanItemInstanceEntityImpl extends AbstractCmmnEngineEntity
     protected boolean showInOverview;
     protected String tenantId = CmmnEngineConfiguration.NO_TENANT_ID;
     protected String localizedName;
+    protected List<HistoricVariableInstanceEntity> queryVariables;
 
     public HistoricPlanItemInstanceEntityImpl() {
     }
@@ -466,6 +472,33 @@ public void setLocalizedName(String localizedName) {
         this.localizedName = localizedName;
     }
 
+    @Override
+    public Map<String, Object> getPlanItemInstanceLocalVariables() {
+        Map<String, Object> variables = new HashMap<>();
+        if (queryVariables != null) {
+            for (HistoricVariableInstance variableInstance : queryVariables) {
+                if (variableInstance.getId() != null && variableInstance.getSubScopeId() != null) {
+                    variables.put(variableInstance.getVariableName(), variableInstance.getValue());
+                }
+            }
+        }
+        return variables;
+    }
+
+    @Override
+    public List<HistoricVariableInstanceEntity> getQueryVariables() {
+        if (queryVariables == null && Context.getCommandContext() != null) {
+            queryVariables = new HistoricVariableInitializingList();
+        }
+        return queryVariables;
+    }
+
+    public void setQueryVariables(List<HistoricVariableInstanceEntity> queryVariables) {
+        this.queryVariables = queryVariables;
+    }
+
+
+
     @Override
     public String toString() {
         StringBuilder sb = new StringBuilder();

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

@@ -18,6 +18,7 @@
 import org.flowable.cmmn.api.history.HistoricPlanItemInstance;
 import org.flowable.cmmn.api.history.HistoricPlanItemInstanceQuery;
 import org.flowable.cmmn.api.runtime.PlanItemInstance;
+import org.flowable.cmmn.engine.impl.history.HistoricPlanItemInstanceQueryImpl;
 import org.flowable.common.engine.impl.persistence.entity.EntityManager;
 
 /**
@@ -38,4 +39,6 @@ public interface HistoricPlanItemInstanceEntityManager extends EntityManager<His
     void bulkDeleteHistoricPlanItemInstancesForCaseInstanceIds(Collection<String> caseInstanceIds);
 
     void deleteHistoricPlanItemInstancesForNonExistingCaseInstances();
+
+    List<HistoricPlanItemInstance> findWithVariablesByCriteria(HistoricPlanItemInstanceQueryImpl historicPlanItemInstanceQuery);
 }

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

@@ -69,4 +69,9 @@ public void bulkDeleteHistoricPlanItemInstancesForCaseInstanceIds(Collection<Str
     public void deleteHistoricPlanItemInstancesForNonExistingCaseInstances() {
         dataManager.deleteHistoricPlanItemInstancesForNonExistingCaseInstances();
     }
+
+    @Override
+    public List<HistoricPlanItemInstance> findWithVariablesByCriteria(HistoricPlanItemInstanceQueryImpl historicPlanItemInstanceQuery) {
+        return dataManager.findWithVariablesByCriteria(historicPlanItemInstanceQuery);
+    }
 }