Map the definition id of the variables fetched by queries that include variables

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

@@ -229,7 +229,7 @@
     </select>
 
     <resultMap id="caseInstanceResultMapWithVariables" type="org.flowable.cmmn.engine.impl.persistence.entity.CaseInstanceEntityImpl" extends="caseInstanceResultMap">
-        <collection property="queryVariables" column="SCOPE_ID_" javaType="ArrayList"
+        <collection property="queryVariables" column="SCOPE_ID_" javaType="ArrayList" notNullColumn="VAR_ID_"
                     ofType="org.flowable.variable.service.impl.persistence.entity.VariableInstanceEntityImpl">
             <id property="id" column="VAR_ID_" jdbcType="NVARCHAR"/>
             <result property="name" column="VAR_NAME_" javaType="String" jdbcType="NVARCHAR"/>
@@ -241,6 +241,7 @@
             <result property="scopeId" column="VAR_SCOPE_ID_" jdbcType="NVARCHAR"/>
             <result property="subScopeId" column="VAR_SUB_SCOPE_ID_" jdbcType="NVARCHAR"/>
             <result property="scopeType" column="VAR_SCOPE_TYPE_" jdbcType="NVARCHAR"/>
+            <result property="scopeDefinitionId" column="CASE_DEF_ID_" jdbcType="VARCHAR"/>
             <result property="metaInfo" column="VAR_META_INFO_" jdbcType="NVARCHAR" />
             <result property="byteArrayRef" column="VAR_BYTEARRAY_ID_" typeHandler="VariableByteArrayRefTypeHandler"/>
             <result property="doubleValue" column="VAR_DOUBLE_" jdbcType="DOUBLE"/>

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

@@ -218,7 +218,7 @@
     <resultMap id="historicCaseInstanceResultMapWithVariables"
                type="org.flowable.cmmn.engine.impl.persistence.entity.HistoricCaseInstanceEntityImpl"
                extends="historicCaseInstanceResultMap">
-        <collection property="queryVariables" column="SCOPE_ID_" javaType="ArrayList"
+        <collection property="queryVariables" column="SCOPE_ID_" javaType="ArrayList" notNullColumn="VAR_ID_"
                     ofType="org.flowable.variable.service.impl.persistence.entity.HistoricVariableInstanceEntityImpl">
             <id property="id" column="VAR_ID_" jdbcType="NVARCHAR"/>
             <result property="name" column="VAR_NAME_" javaType="String" jdbcType="NVARCHAR"/>
@@ -230,6 +230,7 @@
             <result property="scopeId" column="VAR_SCOPE_ID_" jdbcType="NVARCHAR"/>
             <result property="subScopeId" column="VAR_SUB_SCOPE_ID_" jdbcType="NVARCHAR"/>
             <result property="scopeType" column="VAR_SCOPE_TYPE_" jdbcType="NVARCHAR"/>
+            <result property="scopeDefinitionId" column="CASE_DEF_ID_" jdbcType="VARCHAR"/>
             <result property="metaInfo" column="VAR_META_INFO_" jdbcType="NVARCHAR" />
             <result property="byteArrayRef" column="VAR_BYTEARRAY_ID_" typeHandler="VariableByteArrayRefTypeHandler"/>
             <result property="doubleValue" column="VAR_DOUBLE_" jdbcType="DOUBLE"/>

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

@@ -331,7 +331,7 @@
     </resultMap>
 
     <resultMap id="historicPlanItemInstanceResultMapWithVariables" type="org.flowable.cmmn.engine.impl.persistence.entity.HistoricPlanItemInstanceEntityImpl" extends="historicPlanItemInstanceResultMap">
-        <collection property="queryVariables" column="SCOPE_ID_" javaType="ArrayList"
+        <collection property="queryVariables" column="SCOPE_ID_" javaType="ArrayList" notNullColumn="VAR_ID_"
                     ofType="org.flowable.variable.service.impl.persistence.entity.HistoricVariableInstanceEntityImpl">
             <id property="id" column="VAR_ID_" jdbcType="NVARCHAR"/>
             <result property="name" column="VAR_NAME_" javaType="String" jdbcType="NVARCHAR"/>
@@ -343,6 +343,7 @@
             <result property="scopeId" column="VAR_SCOPE_ID_" jdbcType="NVARCHAR"/>
             <result property="subScopeId" column="VAR_SUB_SCOPE_ID_" jdbcType="NVARCHAR"/>
             <result property="scopeType" column="VAR_SCOPE_TYPE_" jdbcType="NVARCHAR"/>
+            <result property="scopeDefinitionId" column="CASE_DEF_ID_" jdbcType="VARCHAR"/>
             <result property="metaInfo" column="VAR_META_INFO_" jdbcType="NVARCHAR" />
             <result property="byteArrayRef" column="VAR_BYTEARRAY_ID_" typeHandler="VariableByteArrayRefTypeHandler"/>
             <result property="doubleValue" column="VAR_DOUBLE_" jdbcType="DOUBLE"/>

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

@@ -330,7 +330,7 @@
   </resultMap>
 
     <resultMap id="planItemInstanceResultMapWithVariables" type="org.flowable.cmmn.engine.impl.persistence.entity.PlanItemInstanceEntityImpl" extends="planItemInstanceResultMap">
-        <collection property="queryVariables" column="SCOPE_ID_" javaType="ArrayList"
+        <collection property="queryVariables" column="SCOPE_ID_" javaType="ArrayList" notNullColumn="VAR_ID_"
                     ofType="org.flowable.variable.service.impl.persistence.entity.VariableInstanceEntityImpl">
             <id property="id" column="VAR_ID_" jdbcType="NVARCHAR"/>
             <result property="name" column="VAR_NAME_" javaType="String" jdbcType="NVARCHAR"/>
@@ -342,6 +342,7 @@
             <result property="scopeId" column="VAR_SCOPE_ID_" jdbcType="NVARCHAR"/>
             <result property="subScopeId" column="VAR_SUB_SCOPE_ID_" jdbcType="NVARCHAR"/>
             <result property="scopeType" column="VAR_SCOPE_TYPE_" jdbcType="NVARCHAR"/>
+            <result property="scopeDefinitionId" column="CASE_DEF_ID_" jdbcType="VARCHAR"/>
             <result property="metaInfo" column="VAR_META_INFO_" jdbcType="NVARCHAR" />
             <result property="byteArrayRef" column="VAR_BYTEARRAY_ID_" typeHandler="VariableByteArrayRefTypeHandler"/>
             <result property="doubleValue" column="VAR_DOUBLE_" jdbcType="DOUBLE"/>

modules/flowable-cmmn-engine/src/test/java/org/flowable/cmmn/test/history/HistoricCaseInstanceQueryImplTest.java

@@ -31,6 +31,7 @@
 import org.flowable.cmmn.api.runtime.CaseInstanceState;
 import org.flowable.cmmn.api.runtime.PlanItemInstance;
 import org.flowable.cmmn.engine.CaseLocalizationManager;
+import org.flowable.cmmn.engine.impl.persistence.entity.HistoricCaseInstanceEntity;
 import org.flowable.cmmn.engine.impl.runtime.CaseInstanceQueryImpl;
 import org.flowable.cmmn.engine.test.CmmnDeployment;
 import org.flowable.cmmn.engine.test.impl.CmmnHistoryTestHelper;
@@ -39,6 +40,7 @@
 import org.flowable.common.engine.impl.identity.Authentication;
 import org.flowable.identitylink.api.IdentityLinkType;
 import org.flowable.task.api.Task;
+import org.flowable.variable.api.history.HistoricVariableInstance;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
@@ -1954,6 +1956,17 @@ public void testQueryCaseInstanceWithVariablesReturnsCaseDefinitionInformation()
             assertThat(historicCaseInstance.getCaseVariables()).containsOnly(
                 entry("stringVar", "test")
             );
+            assertThat(((HistoricCaseInstanceEntity) historicCaseInstance).getQueryVariables())
+                    .extracting(HistoricVariableInstance::getScopeDefinitionId)
+                    .containsExactly(historicCaseInstance.getCaseDefinitionId());
+
+            String caseInstanceWithoutVariablesId = cmmnRuntimeService.createCaseInstanceBuilder().caseDefinitionKey("oneTaskCase").start().getId();
+            historicCaseInstance = cmmnHistoryService.createHistoricCaseInstanceQuery()
+                    .caseInstanceId(caseInstanceWithoutVariablesId)
+                    .includeCaseVariables()
+                    .singleResult();
+            assertThat(historicCaseInstance.getCaseVariables()).isEmpty();
+            assertThat(((HistoricCaseInstanceEntity) historicCaseInstance).getQueryVariables()).isEmpty();
         }
     }
 

modules/flowable-cmmn-engine/src/test/java/org/flowable/cmmn/test/history/HistoricPlanItemInstanceQueryTest.java

@@ -15,6 +15,7 @@
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
 import static org.assertj.core.api.Assertions.entry;
+import static org.assertj.core.api.Assertions.tuple;
 
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -30,12 +31,16 @@
 import org.flowable.cmmn.api.runtime.PlanItemInstance;
 import org.flowable.cmmn.api.runtime.PlanItemInstanceState;
 import org.flowable.cmmn.engine.PlanItemLocalizationManager;
+import org.flowable.cmmn.engine.impl.persistence.entity.HistoricPlanItemInstanceEntity;
 import org.flowable.cmmn.engine.test.CmmnDeployment;
 import org.flowable.cmmn.engine.test.impl.CmmnHistoryTestHelper;
 import org.flowable.cmmn.test.FlowableCmmnTestCase;
 import org.flowable.common.engine.api.FlowableIllegalArgumentException;
 import org.flowable.common.engine.impl.history.HistoryLevel;
 import org.flowable.task.api.Task;
+import org.flowable.task.api.history.HistoricTaskInstance;
+import org.flowable.task.service.impl.persistence.entity.HistoricTaskInstanceEntity;
+import org.flowable.variable.api.history.HistoricVariableInstance;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
@@ -359,6 +364,16 @@ public void testIncludeLocalVariables() {
                 .singleResult();
 
         cmmnTaskService.complete(task.getId());
+        HistoricTaskInstance historicTask = cmmnHistoryService.createHistoricTaskInstanceQuery()
+                .taskId(task.getId())
+                .includeCaseVariables()
+                .includeTaskLocalVariables()
+                .singleResult();
+        assertThat(((HistoricTaskInstanceEntity) historicTask).getQueryVariables())
+                .extracting(HistoricVariableInstance::getScopeDefinitionId, HistoricVariableInstance::getProcessDefinitionId)
+                .isNotEmpty()
+                .containsOnly(tuple(historicTask.getScopeDefinitionId(), null));
+
         HistoricPlanItemInstance planItemInstance = cmmnHistoryService.createHistoricPlanItemInstanceQuery()
                 .planItemInstanceId(planItemInstances.get(0).getId()).singleResult();
         assertThat(planItemInstance.getPlanItemInstanceLocalVariables()).isEmpty();
@@ -370,6 +385,14 @@ public void testIncludeLocalVariables() {
         assertThat(planItemInstance.getPlanItemInstanceLocalVariables()).containsOnly(
                 entry("localVar", "someValue")
         );
+        assertThat(((HistoricPlanItemInstanceEntity) planItemInstance).getQueryVariables())
+                .extracting(HistoricVariableInstance::getScopeDefinitionId)
+                .containsExactly(planItemInstance.getCaseDefinitionId());
+
+        planItemInstance = cmmnHistoryService.createHistoricPlanItemInstanceQuery().planItemInstanceId(planItemInstances.get(1).getId()).includeLocalVariables()
+                .singleResult();
+        assertThat(planItemInstance.getPlanItemInstanceLocalVariables()).isEmpty();
+        assertThat(((HistoricPlanItemInstanceEntity) planItemInstance).getQueryVariables()).isEmpty();
     }
 
     @Test

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

@@ -50,6 +50,7 @@
 import org.flowable.common.engine.impl.interceptor.CommandExecutor;
 import org.flowable.identitylink.api.IdentityLinkType;
 import org.flowable.task.api.Task;
+import org.flowable.variable.api.persistence.entity.VariableInstance;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
@@ -1968,6 +1969,17 @@ public void testQueryCaseInstanceWithVariablesReturnsCaseDefinitionInformation()
         assertThat(caseInstance.getCaseVariables()).containsOnly(
                 entry("stringVar","test")
         );
+        assertThat(((CaseInstanceEntity) caseInstance).getQueryVariables())
+                .extracting(VariableInstance::getScopeDefinitionId)
+                .containsExactly(caseInstance.getCaseDefinitionId());
+
+        String caseInstanceWithoutVariablesId = cmmnRuntimeService.createCaseInstanceBuilder().caseDefinitionKey("oneTaskCase").start().getId();
+        caseInstance = cmmnRuntimeService.createCaseInstanceQuery()
+                .caseInstanceId(caseInstanceWithoutVariablesId)
+                .includeCaseVariables()
+                .singleResult();
+        assertThat(caseInstance.getCaseVariables()).isEmpty();
+        assertThat(((CaseInstanceEntity) caseInstance).getQueryVariables()).isEmpty();
     }
 
 

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

@@ -30,9 +30,12 @@
 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.persistence.entity.PlanItemInstanceEntity;
 import org.flowable.cmmn.engine.test.CmmnDeployment;
 import org.flowable.cmmn.test.FlowableCmmnTestCase;
 import org.flowable.task.api.Task;
+import org.flowable.task.service.impl.persistence.entity.TaskEntity;
+import org.flowable.variable.api.persistence.entity.VariableInstance;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
@@ -1638,6 +1641,10 @@ public void testIncludeLocalVariables() {
                 .includeCaseVariables()
                 .includeTaskLocalVariables()
                 .singleResult();
+        assertThat(((TaskEntity) task).getQueryVariables())
+                .extracting(VariableInstance::getScopeDefinitionId, VariableInstance::getProcessDefinitionId)
+                .isNotEmpty()
+                .containsOnly(tuple(task.getScopeDefinitionId(), null));
 
         PlanItemInstance planItemInstance = cmmnRuntimeService.createPlanItemInstanceQuery().planItemInstanceId(planItemInstances.get(0).getId()).singleResult();
         assertThat(planItemInstance.getPlanItemInstanceLocalVariables()).isEmpty();
@@ -1647,6 +1654,13 @@ public void testIncludeLocalVariables() {
         assertThat(planItemInstance.getPlanItemInstanceLocalVariables()).containsOnly(
                 entry("localVar", "someValue")
         );
+        assertThat(((PlanItemInstanceEntity) planItemInstance).getQueryVariables())
+                .extracting(VariableInstance::getScopeDefinitionId)
+                .containsExactly(planItemInstance.getCaseDefinitionId());
+
+        planItemInstance = cmmnRuntimeService.createPlanItemInstanceQuery().planItemInstanceId(planItemInstances.get(1).getId()).includeLocalVariables().singleResult();
+        assertThat(planItemInstance.getPlanItemInstanceLocalVariables()).isEmpty();
+        assertThat(((PlanItemInstanceEntity) planItemInstance).getQueryVariables()).isEmpty();
     }
 
     @Test

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

@@ -408,6 +408,44 @@ public void testHistoricVariables() {
         }
     }
 
+    @Test
+    @CmmnDeployment(resources = "org/flowable/cmmn/test/one-human-task-model.cmmn")
+    public void testHistoricVariableCreatedAndUpdatedFromRuntimeVariable() {
+        CaseInstance caseInstance = cmmnRuntimeService.createCaseInstanceBuilder().caseDefinitionKey("oneTaskCase").start();
+
+        if (CmmnHistoryTestHelper.isHistoryLevelAtLeast(HistoryLevel.ACTIVITY, cmmnEngineConfiguration)) {
+            HistoricVariableInstance createdVariable = cmmnEngineConfiguration.getCommandExecutor().execute(commandContext -> {
+                cmmnRuntimeService.setVariable(caseInstance.getId(), "customer", "Kermit");
+                return getHistoricVariableInstance(cmmnRuntimeService.getVariableInstance(caseInstance.getId(), "customer").getId());
+            });
+            assertThat(createdVariable)
+                    .extracting(HistoricVariableInstance::getValue, HistoricVariableInstance::getScopeDefinitionId)
+                    .containsExactly("Kermit", caseInstance.getCaseDefinitionId());
+
+            HistoricVariableInstance updatedVariable = cmmnEngineConfiguration.getCommandExecutor().execute(commandContext -> {
+                cmmnRuntimeService.setVariable(caseInstance.getId(), "customer", "Gonzo");
+                return getHistoricVariableInstance(cmmnRuntimeService.getVariableInstance(caseInstance.getId(), "customer").getId());
+            });
+            assertThat(updatedVariable)
+                    .extracting(HistoricVariableInstance::getValue, HistoricVariableInstance::getScopeDefinitionId)
+                    .containsExactly("Gonzo", caseInstance.getCaseDefinitionId());
+
+            String taskId = cmmnTaskService.createTaskQuery().caseInstanceId(caseInstance.getId()).singleResult().getId();
+            HistoricVariableInstance createdTaskVariable = cmmnEngineConfiguration.getCommandExecutor().execute(commandContext -> {
+                cmmnTaskService.setVariableLocal(taskId, "taskCustomer", "Kermit");
+                return getHistoricVariableInstance(cmmnTaskService.getVariableInstanceLocal(taskId, "taskCustomer").getId());
+            });
+            assertThat(createdTaskVariable)
+                    .extracting(HistoricVariableInstance::getValue, HistoricVariableInstance::getScopeDefinitionId)
+                    .containsExactly("Kermit", caseInstance.getCaseDefinitionId());
+        }
+    }
+
+    protected HistoricVariableInstance getHistoricVariableInstance(String variableId) {
+        // Called in the command that created or updated the variable, so the historic variable is the one from the entity cache
+        return cmmnEngineConfiguration.getVariableServiceConfiguration().getHistoricVariableService().getHistoricVariableInstance(variableId);
+    }
+
     @Test
     @CmmnDeployment(resources = "org/flowable/cmmn/test/task/CmmnTaskServiceTest.testOneHumanTaskCase.cmmn")
     public void testVariableInstanceQueryByCaseInstanceIds() {

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

@@ -543,12 +543,13 @@
     <result property="dueDate" column="DUE_DATE_" jdbcType="TIMESTAMP" />
     <result property="claimTime" column="CLAIM_TIME_" jdbcType="TIMESTAMP" />
     <result property="claimedBy" column="CLAIMED_BY_" jdbcType="NVARCHAR" />
-    <collection property="queryVariables" column="EXECUTION_ID_" javaType="ArrayList" ofType="org.flowable.variable.service.impl.persistence.entity.VariableInstanceEntityImpl">
+    <collection property="queryVariables" column="EXECUTION_ID_" javaType="ArrayList" notNullColumn="VAR_ID_" ofType="org.flowable.variable.service.impl.persistence.entity.VariableInstanceEntityImpl">
       <id property="id" column="VAR_ID_" jdbcType="NVARCHAR" />
       <result property="name" column="VAR_NAME_" javaType="String" jdbcType="NVARCHAR" />
       <result property="type" column="VAR_TYPE_" javaType="org.flowable.variable.api.types.VariableType" jdbcType="NVARCHAR" />
       <result property="revision" column="VAR_REV_" jdbcType="INTEGER" />
       <result property="processInstanceId" column="VAR_PROC_INST_ID_" jdbcType="NVARCHAR" />
+      <result property="processDefinitionId" column="PROC_DEF_ID_" jdbcType="NVARCHAR" />
       <result property="executionId" column="VAR_EXECUTION_ID_" jdbcType="NVARCHAR" />
       <result property="taskId" column="VAR_TASK_ID_" jdbcType="NVARCHAR" />
       <result property="metaInfo" column="VAR_META_INFO_" jdbcType="NVARCHAR" />

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

@@ -362,12 +362,13 @@
     <result property="propagatedStageInstanceId" column="PROPAGATED_STAGE_INST_ID_" jdbcType="NVARCHAR" />
     <result property="state" column="STATE_" jdbcType="NVARCHAR" />
     <result property="endUserId" column="END_USER_ID_" jdbcType="NVARCHAR" />
-    <collection property="queryVariables" column="EXECUTION_ID_" javaType="ArrayList" ofType="org.flowable.variable.service.impl.persistence.entity.HistoricVariableInstanceEntityImpl">
+    <collection property="queryVariables" column="EXECUTION_ID_" javaType="ArrayList" notNullColumn="VAR_ID_" ofType="org.flowable.variable.service.impl.persistence.entity.HistoricVariableInstanceEntityImpl">
       <id property="id" column="VAR_ID_" jdbcType="NVARCHAR"/>
       <result property="name" column="VAR_NAME_" javaType="String" jdbcType="NVARCHAR" />
       <result property="variableType" column="VAR_TYPE_" javaType="org.flowable.variable.api.types.VariableType" jdbcType="NVARCHAR" />
       <result property="revision" column="VAR_REV_" jdbcType="INTEGER" />
       <result property="processInstanceId" column="VAR_PROC_INST_ID_" jdbcType="NVARCHAR" />
+      <result property="processDefinitionId" column="PROC_DEF_ID_" jdbcType="NVARCHAR" />
       <result property="executionId" column="VAR_EXECUTION_ID_" jdbcType="NVARCHAR" />
       <result property="taskId" column="VAR_TASK_ID_" jdbcType="NVARCHAR" />
       <result property="metaInfo" column="VAR_META_INFO_" jdbcType="NVARCHAR" />