Merge pull request #61 from tsurdilo/filterupdate

Tihomir Surdilovic · web-flow · commit 30aaa49fe645 · 2021-03-09T10:09:27.000-05:00
update data filters
diff --git a/README.md b/README.md
@@ -126,7 +126,7 @@ states:
     actionDataFilter:
       dataResultsPath: ".payload.greeting"
   stateDataFilter:
-    dataOutputPath: ".greeting"
+    output: ".greeting"
   end: true
 ```
 
diff --git a/api/src/main/resources/schema/default/defaultdef.json b/api/src/main/resources/schema/default/defaultdef.json
@@ -9,7 +9,7 @@
     },
     "end": {
       "$ref": "../end/end.json",
-      "description": "Explicit transition to end"
+      "description": "Workflow end definition"
     }
   },
   "oneOf": [
diff --git a/api/src/main/resources/schema/filters/actiondatafilter.json b/api/src/main/resources/schema/filters/actiondatafilter.json
@@ -2,13 +2,17 @@
   "type": "object",
   "javaType": "io.serverlessworkflow.api.filters.ActionDataFilter",
   "properties": {
-    "dataInputPath": {
+    "fromStateData": {
       "type": "string",
-      "description": "JSONPath definition that selects parts of the states data input to be the action data"
+      "description": "Workflow expression that selects state data that the state action can use"
     },
-    "dataResultsPath": {
+    "results": {
       "type": "string",
-      "description": "JSONPath definition that selects parts of the actions data result, to be merged with the states data"
+      "description": "Workflow expression that filters the actions data results"
+    },
+    "toStateData": {
+      "type": "string",
+      "description": "Workflow expression that selects a state data element to which the action results should be added/merged into. If not specified, denote, the top-level state data element"
     }
   },
   "required": []
diff --git a/api/src/main/resources/schema/filters/eventdatafilter.json b/api/src/main/resources/schema/filters/eventdatafilter.json
@@ -2,9 +2,13 @@
   "type": "object",
   "javaType": "io.serverlessworkflow.api.filters.EventDataFilter",
   "properties": {
-    "dataOutputPath": {
+    "data": {
       "type": "string",
-      "description": "JSONPath definition that selects parts of the event data, to be merged with the states data"
+      "description": "Workflow expression that filters of the event data (payload)"
+    },
+    "toStateData": {
+      "type": "string",
+      "description": " Workflow expression that selects a state data element to which the event payload should be added/merged into. If not specified, denotes, the top-level state data element."
     }
   },
   "required": []
diff --git a/api/src/main/resources/schema/filters/statedatafilter.json b/api/src/main/resources/schema/filters/statedatafilter.json
@@ -2,13 +2,13 @@
   "type": "object",
   "javaType": "io.serverlessworkflow.api.filters.StateDataFilter",
   "properties": {
-    "dataInputPath": {
+    "input": {
       "type": "string",
-      "description": "JSONPath definition that selects parts of the states data input"
+      "description": "Workflow expression to filter the state data input"
     },
-    "dataOutputPath": {
+    "output": {
       "type": "string",
-      "description": "JSONPath definition that selects parts of the states data output"
+      "description": "Workflow expression that filters the state data output"
     }
   },
   "required": []
diff --git a/api/src/main/resources/schema/produce/produceevent.json b/api/src/main/resources/schema/produce/produceevent.json
@@ -9,7 +9,7 @@
     },
     "data": {
       "type": "string",
-      "description": "JSONPath expression which selects parts of the states data output to become the data of the produced event"
+      "description": "Workflow expression which selects parts of the states data output to become the data of the produced event"
     }
   },
   "required": [
diff --git a/api/src/main/resources/schema/states/foreachstate.json b/api/src/main/resources/schema/states/foreachstate.json
@@ -11,11 +11,11 @@
   "properties": {
     "inputCollection": {
       "type": "string",
-      "description": "JsonPath expression selecting an array element of the states data"
+      "description": "Workflow expression selecting an array element of the states data"
     },
     "outputCollection": {
       "type": "string",
-      "description": "JsonPath expression specifying an array element of the states data to add the results of each iteration"
+      "description": "Workflow expression specifying an array element of the states data to add the results of each iteration"
     },
     "iterationParam": {
       "type": "string",
diff --git a/api/src/main/resources/schema/switchconditions/datacondition.json b/api/src/main/resources/schema/switchconditions/datacondition.json
@@ -12,15 +12,15 @@
     },
     "condition": {
       "type": "string",
-      "description": "JsonPath expression evaluated against state data. True if results are not empty"
+      "description": "Workflow expression evaluated against state data. True if results are not empty"
     },
     "transition": {
       "$ref": "../transitions/transition.json",
       "description": "Next transition of the workflow if there is valid matches"
     },
     "end": {
       "$ref": "../end/end.json",
-      "description": "Explicit transition to end"
+      "description": "Workflow end definition"
     }
   },
   "required": [
diff --git a/api/src/main/resources/schema/switchconditions/eventcondition.json b/api/src/main/resources/schema/switchconditions/eventcondition.json
@@ -22,7 +22,7 @@
     },
     "end": {
       "$ref": "../end/end.json",
-      "description": "Explicit transition to end"
+      "description": "Workflow end definition"
     }
   },
   "required": [
diff --git a/api/src/test/resources/examples/eventbasedgreeting.json b/api/src/test/resources/examples/eventbasedgreeting.json
@@ -24,7 +24,7 @@
       "onEvents": [{
         "eventRefs": ["GreetingEvent"],
         "eventDataFilter": {
-          "dataOutputPath": "${ .data.greet }"
+          "data": "${ .data.greet }"
         },
         "actions":[
           {
@@ -38,7 +38,7 @@
         ]
       }],
       "stateDataFilter": {
-        "dataOutputPath": "${ .payload.greeting }"
+        "output": "${ .payload.greeting }"
       },
       "end": true
     }
diff --git a/api/src/test/resources/examples/eventbasedgreeting.yml b/api/src/test/resources/examples/eventbasedgreeting.yml
@@ -17,12 +17,12 @@ states:
       - eventRefs:
           - GreetingEvent
         eventDataFilter:
-          dataOutputPath: "${ .data.greet }"
+          data: "${ .data.greet }"
         actions:
           - functionRef:
               refName: greetingFunction
               arguments:
                 name: "${ .greet.name }"
     stateDataFilter:
-      dataOutputPath: "${ .payload.greeting }"
+      output: "${ .payload.greeting }"
     end: true
diff --git a/api/src/test/resources/examples/greeting.json b/api/src/test/resources/examples/greeting.json
@@ -23,7 +23,7 @@
             }
           },
           "actionDataFilter": {
-            "dataResultsPath": "${ .greeting }"
+            "results": "${ .greeting }"
           }
         }
       ],
diff --git a/api/src/test/resources/examples/greeting.yml b/api/src/test/resources/examples/greeting.yml
@@ -15,5 +15,5 @@ states:
           arguments:
             name: "${ .person.name }"
         actionDataFilter:
-          dataResultsPath: "${ .greeting }"
+          results: "${ .greeting }"
     end: true
diff --git a/api/src/test/resources/examples/jobmonitoring.json b/api/src/test/resources/examples/jobmonitoring.json
@@ -36,7 +36,7 @@
             }
           },
           "actionDataFilter": {
-            "dataResultsPath": "${ .jobuid }"
+            "results": "${ .jobuid }"
           }
         }
       ],
@@ -47,7 +47,7 @@
         }
       ],
       "stateDataFilter": {
-        "dataOutputPath": "${ .jobuid }"
+        "output": "${ .jobuid }"
       },
       "transition": "WaitForCompletion'"
     },
@@ -76,12 +76,12 @@
             }
           },
           "actionDataFilter": {
-            "dataResultsPath": "${ .jobstatus }"
+            "results": "${ .jobstatus }"
           }
         }
       ],
       "stateDataFilter": {
-        "dataOutputPath": "${ .jobstatus }"
+        "output": "${ .jobstatus }"
       },
       "transition": "DetermineCompletion"
     },
diff --git a/api/src/test/resources/examples/jobmonitoring.yml b/api/src/test/resources/examples/jobmonitoring.yml
@@ -22,12 +22,12 @@ states:
           arguments:
             name: "${ .job.name }"
         actionDataFilter:
-          dataResultsPath: "${ .jobuid }"
+          results: "${ .jobuid }"
     onErrors:
       - error: "*"
         transition: SubmitError
     stateDataFilter:
-      dataOutputPath: "${ .jobuid }"
+      output: "${ .jobuid }"
     transition: WaitForCompletion
   - name: SubmitError
     type: subflow
@@ -46,9 +46,9 @@ states:
           arguments:
             name: "${ .jobuid }"
         actionDataFilter:
-          dataResultsPath: "${ .jobstatus }"
+          results: "${ .jobstatus }"
     stateDataFilter:
-      dataOutputPath: "${ .jobstatus }"
+      output: "${ .jobstatus }"
     transition: DetermineCompletion
   - name: DetermineCompletion
     type: switch
diff --git a/api/src/test/resources/examples/provisionorder.json b/api/src/test/resources/examples/provisionorder.json
@@ -26,7 +26,7 @@
         }
       ],
       "stateDataFilter": {
-        "dataOutputPath": "${ .exceptions }"
+        "output": "${ .exceptions }"
       },
       "transition": "ApplyOrder",
       "onErrors": [
diff --git a/api/src/test/resources/examples/provisionorder.yml b/api/src/test/resources/examples/provisionorder.yml
@@ -16,7 +16,7 @@ states:
           arguments:
             order: "${ .order }"
     stateDataFilter:
-      dataOutputPath: "${ .exceptions }"
+      output: "${ .exceptions }"
     transition: ApplyOrder
     onErrors:
       - error: Missing order id
diff --git a/api/src/test/resources/examples/roomreadings.json b/api/src/test/resources/examples/roomreadings.json
@@ -23,7 +23,7 @@
             }
           ],
           "eventDataFilter": {
-            "dataOutputPath": "${ .readings }"
+            "data": "${ .readings }"
           }
         }
       ],
diff --git a/api/src/test/resources/examples/roomreadings.yml b/api/src/test/resources/examples/roomreadings.yml
@@ -17,7 +17,7 @@ states:
           - functionRef:
               refName: LogReading
         eventDataFilter:
-          dataOutputPath: "${ .readings }"
+          data: "${ .readings }"
     end: true
   - name: GenerateReport
     type: operation
diff --git a/api/src/test/resources/examples/solvemathproblems.json b/api/src/test/resources/examples/solvemathproblems.json
@@ -28,7 +28,7 @@
         }
       ],
       "stateDataFilter": {
-        "dataOutputPath": "${ .results }"
+        "output": "${ .results }"
       },
       "end": true
     }
diff --git a/api/src/test/resources/examples/solvemathproblems.yml b/api/src/test/resources/examples/solvemathproblems.yml
@@ -18,5 +18,5 @@ states:
           arguments:
             expression: "${ .singleexpression }"
     stateDataFilter:
-      dataOutputPath: "${ .results }"
+      output: "${ .results }"
     end: true
diff --git a/api/src/test/resources/examples/vetappointmentservice.json b/api/src/test/resources/examples/vetappointmentservice.json
@@ -29,7 +29,7 @@
             "resultEventRef":  "VetAppointmentInfo"
           },
           "actionDataFilter": {
-            "dataResultsPath": "${ .appointmentInfo }"
+            "results": "${ .appointmentInfo }"
           },
           "timeout": "PT15M"
         }
diff --git a/api/src/test/resources/examples/vetappointmentservice.yml b/api/src/test/resources/examples/vetappointmentservice.yml
@@ -20,6 +20,6 @@ states:
           data: "${ .patientInfo }"
           resultEventRef: VetAppointmentInfo
         actionDataFilter:
-          dataResultsPath: "${ .appointmentInfo }"
+          results: "${ .appointmentInfo }"
         timeout: PT15M
     end: true
diff --git a/api/src/test/resources/features/vetappointment.json b/api/src/test/resources/features/vetappointment.json
@@ -19,7 +19,7 @@
             "resultEventRef":  "VetAppointmentInfo"
           },
           "actionDataFilter": {
-            "dataResultsPath": "${ .appointmentInfo }"
+            "results": "${ .appointmentInfo }"
           },
           "timeout": "PT15M"
         }
diff --git a/api/src/test/resources/features/vetappointment.yml b/api/src/test/resources/features/vetappointment.yml
@@ -15,7 +15,7 @@ states:
           data: "${ .patientInfo }"
           resultEventRef: VetAppointmentInfo
         actionDataFilter:
-          dataResultsPath: "${ .appointmentInfo }"
+          results: "${ .appointmentInfo }"
         timeout: PT15M
     onErrors:
       - error: TimeoutError
diff --git a/diagram/src/test/resources/examples/eventbasedgreeting.json b/diagram/src/test/resources/examples/eventbasedgreeting.json
@@ -24,7 +24,7 @@
       "onEvents": [{
         "eventRefs": ["GreetingEvent"],
         "eventDataFilter": {
-          "dataOutputPath": "${ .data.greet }"
+          "data": "${ .data.greet }"
         },
         "actions":[
           {
@@ -38,7 +38,7 @@
         ]
       }],
       "stateDataFilter": {
-        "dataOutputPath": "${ .payload.greeting }"
+        "output": "${ .payload.greeting }"
       },
       "end": true
     }
diff --git a/diagram/src/test/resources/examples/eventbasedgreeting.yml b/diagram/src/test/resources/examples/eventbasedgreeting.yml
@@ -17,12 +17,12 @@ states:
       - eventRefs:
           - GreetingEvent
         eventDataFilter:
-          dataOutputPath: "${ .data.greet }"
+          data: "${ .data.greet }"
         actions:
           - functionRef:
               refName: greetingFunction
               arguments:
                 name: "${ .greet.name }"
     stateDataFilter:
-      dataOutputPath: "${ .payload.greeting }"
+      output: "${ .payload.greeting }"
     end: true
diff --git a/diagram/src/test/resources/examples/greeting.json b/diagram/src/test/resources/examples/greeting.json
@@ -23,7 +23,7 @@
             }
           },
           "actionDataFilter": {
-            "dataResultsPath": "${ .greeting }"
+            "results": "${ .greeting }"
           }
         }
       ],
diff --git a/diagram/src/test/resources/examples/greeting.yml b/diagram/src/test/resources/examples/greeting.yml
@@ -15,5 +15,5 @@ states:
           arguments:
             name: "${ .person.name }"
         actionDataFilter:
-          dataResultsPath: "${ .greeting }"
+          results: "${ .greeting }"
     end: true
diff --git a/diagram/src/test/resources/examples/jobmonitoring.json b/diagram/src/test/resources/examples/jobmonitoring.json
diff --git a/diagram/src/test/resources/examples/jobmonitoring.yml b/diagram/src/test/resources/examples/jobmonitoring.yml
diff --git a/diagram/src/test/resources/examples/provisionorder.json b/diagram/src/test/resources/examples/provisionorder.json
diff --git a/diagram/src/test/resources/examples/provisionorder.yml b/diagram/src/test/resources/examples/provisionorder.yml
diff --git a/diagram/src/test/resources/examples/roomreadings.json b/diagram/src/test/resources/examples/roomreadings.json
diff --git a/diagram/src/test/resources/examples/roomreadings.yml b/diagram/src/test/resources/examples/roomreadings.yml
diff --git a/diagram/src/test/resources/examples/solvemathproblems.json b/diagram/src/test/resources/examples/solvemathproblems.json
diff --git a/diagram/src/test/resources/examples/solvemathproblems.yml b/diagram/src/test/resources/examples/solvemathproblems.yml
diff --git a/diagram/src/test/resources/examples/vetappointmentservice.json b/diagram/src/test/resources/examples/vetappointmentservice.json
diff --git a/diagram/src/test/resources/examples/vetappointmentservice.yml b/diagram/src/test/resources/examples/vetappointmentservice.yml

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`},`
`10`	`10`	`"end": {`
`11`	`11`	`"$ref": "../end/end.json",`
`12`		`- "description": "Explicit transition to end"`
	`12`	`+ "description": "Workflow end definition"`
`13`	`13`	`}`
`14`	`14`	`},`
`15`	`15`	`"oneOf": [`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`},`
`23`	`23`	`"end": {`
`24`	`24`	`"$ref": "../end/end.json",`
`25`		`- "description": "Explicit transition to end"`
	`25`	`+ "description": "Workflow end definition"`
`26`	`26`	`}`
`27`	`27`	`},`
`28`	`28`	`"required": [`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@`
`24`	`24`	`"onEvents": [{`
`25`	`25`	`"eventRefs": ["GreetingEvent"],`
`26`	`26`	`"eventDataFilter": {`
`27`		`- "dataOutputPath": "${ .data.greet }"`
	`27`	`+ "data": "${ .data.greet }"`
`28`	`28`	`},`
`29`	`29`	`"actions":[`
`30`	`30`	`{`
`@@ -38,7 +38,7 @@`
`38`	`38`	`]`
`39`	`39`	`}],`
`40`	`40`	`"stateDataFilter": {`
`41`		`- "dataOutputPath": "${ .payload.greeting }"`
	`41`	`+ "output": "${ .payload.greeting }"`
`42`	`42`	`},`
`43`	`43`	`"end": true`
`44`	`44`	`}`