Merge pull request #185 from tsurdilo/eventdefdataonly40x

[4.0.x] Add missing dataOnly prop to eventDef

Author: tsurdilo

api/src/main/resources/schema/events/eventdef.json

@@ -24,6 +24,11 @@
         "$ref": "../correlation/correlationdef.json"
       }
     },
+    "dataOnly": {
+      "type": "boolean",
+      "default": true,
+      "description": "If `true`, only the Event payload is accessible to consuming Workflow states. If `false`, both event payload and context attributes should be accessible "
+    },
     "kind": {
       "type" : "string",
       "enum": ["consumed", "produced"],

api/src/test/java/io/serverlessworkflow/api/test/MarkupToWorkflowTest.java

@@ -25,6 +25,7 @@
 import io.serverlessworkflow.api.datainputschema.DataInputSchema;
 import io.serverlessworkflow.api.defaultdef.DefaultConditionDefinition;
 import io.serverlessworkflow.api.end.End;
+import io.serverlessworkflow.api.events.EventDefinition;
 import io.serverlessworkflow.api.events.EventRef;
 import io.serverlessworkflow.api.functions.FunctionDefinition;
 import io.serverlessworkflow.api.functions.FunctionRef;
@@ -39,6 +40,7 @@
 import io.serverlessworkflow.api.test.utils.WorkflowTestUtils;
 import io.serverlessworkflow.api.timeouts.WorkflowExecTimeout;
 import io.serverlessworkflow.api.workflow.Constants;
+import io.serverlessworkflow.api.workflow.Events;
 import io.serverlessworkflow.api.workflow.Retries;
 import io.serverlessworkflow.api.workflow.Secrets;
 import java.util.List;
@@ -852,4 +854,25 @@ public void testAnnotations(String workflowLocation) {
     List<String> annotations = workflow.getAnnotations();
     assertEquals(4, annotations.size());
   }
+
+  @ParameterizedTest
+  @ValueSource(strings = {"/features/eventdefdataonly.json", "/features/eventdefdataonly.yml"})
+  public void testEventDefDataOnly(String workflowLocation) {
+    Workflow workflow = Workflow.fromSource(WorkflowTestUtils.readWorkflowFile(workflowLocation));
+
+    assertNotNull(workflow);
+    assertNotNull(workflow.getId());
+    assertNotNull(workflow.getName());
+
+    assertNotNull(workflow.getEvents());
+    Events events = workflow.getEvents();
+    assertNotNull(workflow.getEvents().getEventDefs());
+    assertEquals(2, events.getEventDefs().size());
+    EventDefinition eventDefOne = events.getEventDefs().get(0);
+    EventDefinition eventDefTwo = events.getEventDefs().get(1);
+    assertEquals("visaApprovedEvent", eventDefOne.getName());
+    assertFalse(eventDefOne.isDataOnly());
+    assertEquals("visaRejectedEvent", eventDefTwo.getName());
+    assertTrue(eventDefTwo.isDataOnly());
+  }
 }

api/src/test/resources/features/eventdefdataonly.json

@@ -0,0 +1,73 @@
+{
+  "id": "eventdefdataonly",
+  "version": "1.0",
+  "specVersion": "0.8",
+  "name": "Event Definition Data Only Test",
+  "description": "Event Definition Data Only Test",
+  "start": "CheckVisaStatus",
+  "events": [
+    {
+      "name": "visaApprovedEvent",
+      "type": "VisaApproved",
+      "source": "visaCheckSource",
+      "dataOnly": false
+    },
+    {
+      "name": "visaRejectedEvent",
+      "type": "VisaRejected",
+      "source": "visaCheckSource"
+    }
+  ],
+  "states":[
+    {
+      "name":"CheckVisaStatus",
+      "type":"switch",
+      "eventConditions": [
+        {
+          "eventRef": "visaApprovedEvent",
+          "transition": "HandleApprovedVisa"
+        },
+        {
+          "eventRef": "visaRejectedEvent",
+          "transition": "HandleRejectedVisa"
+        }
+      ],
+      "timeouts": {
+        "eventTimeout": "PT1H"
+      },
+      "defaultCondition": {
+        "transition": "HandleNoVisaDecision"
+      }
+    },
+    {
+      "name": "HandleApprovedVisa",
+      "type": "operation",
+      "actions": [
+        {
+          "subFlowRef": "handleApprovedVisaWorkflowID"
+        }
+      ],
+      "end": true
+    },
+    {
+      "name": "HandleRejectedVisa",
+      "type": "operation",
+      "actions": [
+        {
+          "subFlowRef": "handleRejectedVisaWorkflowID"
+        }
+      ],
+      "end": true
+    },
+    {
+      "name": "HandleNoVisaDecision",
+      "type": "operation",
+      "actions": [
+        {
+          "subFlowRef": "handleNoVisaDecisionWorkflowId"
+        }
+      ],
+      "end": true
+    }
+  ]
+}

api/src/test/resources/features/eventdefdataonly.yml

@@ -0,0 +1,41 @@
+id: eventdefdataonly
+version: '1.0'
+specVersion: '0.8'
+name: Event Definition Data Only Test
+description: Event Definition Data Only Test
+start: CheckVisaStatus
+events:
+  - name: visaApprovedEvent
+    type: VisaApproved
+    source: visaCheckSource
+    dataOnly: false
+  - name: visaRejectedEvent
+    type: VisaRejected
+    source: visaCheckSource
+states:
+  - name: CheckVisaStatus
+    type: switch
+    eventConditions:
+      - eventRef: visaApprovedEvent
+        transition: HandleApprovedVisa
+      - eventRef: visaRejectedEvent
+        transition: HandleRejectedVisa
+    timeouts:
+      eventTimeout: PT1H
+    defaultCondition:
+      transition: HandleNoVisaDecision
+  - name: HandleApprovedVisa
+    type: operation
+    actions:
+      - subFlowRef: handleApprovedVisaWorkflowID
+    end: true
+  - name: HandleRejectedVisa
+    type: operation
+    actions:
+      - subFlowRef: handleRejectedVisaWorkflowID
+    end: true
+  - name: HandleNoVisaDecision
+    type: operation
+    actions:
+      - subFlowRef: handleNoVisaDecisionWorkflowId
+    end: true