Consider available conditions when creating variable event listeners (#4037)

Author: murselturk

modules/flowable-cmmn-engine/src/main/java/org/flowable/cmmn/engine/impl/behavior/impl/VariableEventListenerActivityBehaviour.java

@@ -42,12 +42,10 @@
  */
 public class VariableEventListenerActivityBehaviour extends CoreCmmnTriggerableActivityBehavior implements PlanItemActivityBehavior {
 
-    protected String variableName;
-    protected String variableChangeType;
+    protected VariableEventListener variableEventListener;
 
     public VariableEventListenerActivityBehaviour(VariableEventListener variableEventListener) {
-        this.variableName = variableEventListener.getVariableName();
-        this.variableChangeType = variableEventListener.getVariableChangeType();
+        this.variableEventListener = variableEventListener;
     }
 
     @Override
@@ -62,17 +60,18 @@ public void onStateTransition(CommandContext commandContext, DelegatePlanItemIns
                 eventSubscriptionService.deleteEventSubscription(eventSubscription);
             }
 
-        } else if (PlanItemTransition.CREATE.equals(transition)) {
+        } else if ((PlanItemTransition.CREATE.equals(transition) && StringUtils.isEmpty(variableEventListener.getAvailableConditionExpression()))
+                || PlanItemTransition.INITIATE.equals(transition)) {
             String configuration = null;
-            if (StringUtils.isNotEmpty(variableChangeType)) {
+            if (StringUtils.isNotEmpty(variableEventListener.getVariableChangeType())) {
                 ObjectNode configurationNode = cmmnEngineConfiguration.getObjectMapper().createObjectNode();
-                configurationNode.put(VariableListenerEventDefinition.CHANGE_TYPE_PROPERTY, variableChangeType);
+                configurationNode.put(VariableListenerEventDefinition.CHANGE_TYPE_PROPERTY, variableEventListener.getVariableChangeType());
                 configuration = configurationNode.toString();
             }
 
             cmmnEngineConfiguration.getEventSubscriptionServiceConfiguration().getEventSubscriptionService().createEventSubscriptionBuilder()
                 .eventType("variable")
-                .eventName(variableName)
+                .eventName(variableEventListener.getVariableName())
                 .configuration(configuration)
                 .subScopeId(planItemInstance.getId())
                 .scopeId(planItemInstance.getCaseInstanceId())
@@ -107,7 +106,7 @@ public void trigger(CommandContext commandContext, PlanItemInstanceEntity planIt
 
             List<EventSubscriptionEntity> eventSubscriptions = eventSubscriptionService.findEventSubscriptionsBySubScopeId(planItemInstanceEntity.getId());
             for (EventSubscriptionEntity eventSubscription : eventSubscriptions) {
-                if ("variable".equals(eventSubscription.getEventType()) && variableName.equals(eventSubscription.getEventName())) {
+                if ("variable".equals(eventSubscription.getEventType()) && variableEventListener.getVariableName().equals(eventSubscription.getEventName())) {
                     eventSubscriptionService.deleteEventSubscription(eventSubscription);
                 }
             }

modules/flowable-cmmn-engine/src/test/java/org/flowable/cmmn/test/eventlistener/VariableEventListenerTest.java

@@ -29,6 +29,32 @@
 
 public class VariableEventListenerTest extends FlowableCmmnTestCase {
 
+    @Test
+    @CmmnDeployment
+    public void testVariableEventListenerWithAvailableCondition() {
+        CaseInstance caseInstance = cmmnRuntimeService.createCaseInstanceBuilder().caseDefinitionKey("variableListener").variable("availableConditionVar", false).start();
+
+        PlanItemInstance listenerInstance = cmmnRuntimeService.createPlanItemInstanceQuery().planItemDefinitionType(PlanItemDefinitionType.VARIABLE_EVENT_LISTENER).singleResult();
+        assertThat(listenerInstance.getState()).isEqualTo(PlanItemInstanceState.UNAVAILABLE);
+
+        // create var1 variable
+        cmmnRuntimeService.setVariable(caseInstance.getId(), "var1", "test1");
+        // should not trigger variable event listener
+        assertThat(cmmnRuntimeService.createPlanItemInstanceQuery().planItemDefinitionType(PlanItemDefinitionType.VARIABLE_EVENT_LISTENER).count()).isEqualTo(1);
+        assertThat(cmmnRuntimeService.createPlanItemInstanceQuery().planItemDefinitionId("taskB").planItemInstanceStateActive().count()).isZero();
+
+        // setting the variable should make the variable event listener available
+        cmmnRuntimeService.setVariable(caseInstance.getId(), "availableConditionVar", true);
+        listenerInstance = cmmnRuntimeService.createPlanItemInstanceQuery().planItemDefinitionType(PlanItemDefinitionType.VARIABLE_EVENT_LISTENER).singleResult();
+        assertThat(listenerInstance.getState()).isEqualTo(PlanItemInstanceState.AVAILABLE);
+
+        // update var1 variable to trigger variable event listener
+        cmmnRuntimeService.setVariable(caseInstance.getId(), "var1", "test2");
+        // variable event listener should be completed
+        assertThat(cmmnRuntimeService.createPlanItemInstanceQuery().planItemDefinitionType(PlanItemDefinitionType.VARIABLE_EVENT_LISTENER).count()).isZero();
+        assertThat(cmmnRuntimeService.createPlanItemInstanceQuery().planItemDefinitionId("taskB").planItemInstanceStateActive().count()).isEqualTo(1);
+    }
+
     @Test
     @CmmnDeployment
     public void testTriggerVariableEventListener() {

modules/flowable-cmmn-engine/src/test/resources/org/flowable/cmmn/test/eventlistener/VariableEventListenerTest.testVariableEventListenerWithAvailableCondition.cmmn

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<definitions xmlns="http://www.omg.org/spec/CMMN/20151109/MODEL"
+             xmlns:flowable="http://flowable.org/cmmn"
+             targetNamespace="http://flowable.org/cmmn">
+    <case id="variableListener" name="Variable listener">
+        <casePlanModel id="casePlanModel">
+            <planItem id="planItemA" name="A" definitionRef="taskA"/>
+            <planItem id="variableEventListenerPlanItem" definitionRef="variableEventListener"/>
+            <planItem id="planItemB" name="B" definitionRef="taskB">
+                <entryCriterion id="entryTaskB" sentryRef="sentryOnVariableEventListener"/>
+            </planItem>
+            <sentry id="sentryOnVariableEventListener">
+                <planItemOnPart id="sentryOnvariableEvent" sourceRef="variableEventListenerPlanItem">
+                    <standardEvent>occur</standardEvent>
+                </planItemOnPart>
+            </sentry>
+            <humanTask id="taskA" name="A"/>
+            <eventListener id="variableEventListener" flowable:eventType="variable" flowable:variableName="var1"
+            flowable:availableCondition="${availableConditionVar}" />
+            <humanTask id="taskB" name="B"/>
+        </casePlanModel>
+    </case>
+</definitions>