Merge pull request #33 from tsurdilo/addcompensation

Tihomir Surdilovic · web-flow · commit 35334106c280 · 2020-12-11T12:35:19.000-05:00
[1.0.x] Workflow compensation impl
diff --git a/api/src/main/java/io/serverlessworkflow/api/interfaces/State.java b/api/src/main/java/io/serverlessworkflow/api/interfaces/State.java
@@ -48,5 +48,7 @@ public interface State {
 
     List<Error> getOnErrors();
 
+    String getCompensatedBy();
+
     Map<String, String> getMetadata();
 }
diff --git a/api/src/main/resources/schema/end/end.json b/api/src/main/resources/schema/end/end.json
@@ -20,6 +20,11 @@
         "type": "object",
         "$ref": "../produce/produceevent.json"
       }
+    },
+    "compensate": {
+      "type": "boolean",
+      "default": false,
+      "description": "If set to true, triggers workflow compensation when before workflow executin completes. Default is false"
     }
   },
   "required": [
diff --git a/api/src/main/resources/schema/states/callbackstate.json b/api/src/main/resources/schema/states/callbackstate.json
@@ -24,6 +24,11 @@
     "eventDataFilter": {
       "description": "Callback event data filter definition",
       "$ref": "../filters/eventdatafilter.json"
+    },
+    "usedForCompensation": {
+      "type": "boolean",
+      "default": false,
+      "description": "If true, this state is used to compensate another state. Default is false"
     }
   },
   "required": [
diff --git a/api/src/main/resources/schema/states/defaultstate.json b/api/src/main/resources/schema/states/defaultstate.json
@@ -64,6 +64,11 @@
         "type": "object",
         "$ref": "../error/error.json"
       }
+    },
+    "compensatedBy": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Unique Name of a workflow state which is responsible for compensation of this state"
     }
   },
   "required": [
diff --git a/api/src/main/resources/schema/states/delaystate.json b/api/src/main/resources/schema/states/delaystate.json
@@ -12,6 +12,11 @@
     "timeDelay": {
       "type": "string",
       "description": "Amount of time (ISO 8601 format) to delay"
+    },
+    "usedForCompensation": {
+      "type": "boolean",
+      "default": false,
+      "description": "If true, this state is used to compensate another state. Default is false"
     }
   },
   "required": [
diff --git a/api/src/main/resources/schema/states/foreachstate.json b/api/src/main/resources/schema/states/foreachstate.json
@@ -38,6 +38,11 @@
     "workflowId": {
       "type": "string",
       "description": "Unique Id of a workflow to be executed for each of the elements of inputCollection"
+    },
+    "usedForCompensation": {
+      "type": "boolean",
+      "default": false,
+      "description": "If true, this state is used to compensate another state. Default is false"
     }
   },
   "oneOf": [
diff --git a/api/src/main/resources/schema/states/injectstate.json b/api/src/main/resources/schema/states/injectstate.json
@@ -13,6 +13,11 @@
       "type": "object",
       "description": "JSON object which can be set as states data input and can be manipulated via filters",
       "existingJavaType": "com.fasterxml.jackson.databind.JsonNode"
+    },
+    "usedForCompensation": {
+      "type": "boolean",
+      "default": false,
+      "description": "If true, this state is used to compensate another state. Default is false"
     }
   },
   "required": [
diff --git a/api/src/main/resources/schema/states/operationstate.json b/api/src/main/resources/schema/states/operationstate.json
@@ -24,6 +24,11 @@
         "type": "object",
         "$ref": "../actions/action.json"
       }
+    },
+    "usedForCompensation": {
+      "type": "boolean",
+      "default": false,
+      "description": "If true, this state is used to compensate another state. Default is false"
     }
   },
   "required": [
diff --git a/api/src/main/resources/schema/states/parallelstate.json b/api/src/main/resources/schema/states/parallelstate.json
@@ -27,6 +27,11 @@
       "type": "string",
       "default": "0",
       "description": "Used when completionType is set to 'n_of_m' to specify the 'N' value"
+    },
+    "usedForCompensation": {
+      "type": "boolean",
+      "default": false,
+      "description": "If true, this state is used to compensate another state. Default is false"
     }
   },
   "required": [
diff --git a/api/src/main/resources/schema/states/subflowstate.json b/api/src/main/resources/schema/states/subflowstate.json
@@ -17,6 +17,11 @@
     "workflowId": {
       "type": "string",
       "description": "Sub-workflow unique id."
+    },
+    "usedForCompensation": {
+      "type": "boolean",
+      "default": false,
+      "description": "If true, this state is used to compensate another state. Default is false"
     }
   },
   "required": [
diff --git a/api/src/main/resources/schema/states/switchstate.json b/api/src/main/resources/schema/states/switchstate.json
@@ -32,6 +32,11 @@
     "default": {
       "description": "Default transition of the workflow if there is no matching data conditions. Can include a transition or end definition",
       "$ref": "../default/defaultdef.json"
+    },
+    "usedForCompensation": {
+      "type": "boolean",
+      "default": false,
+      "description": "If true, this state is used to compensate another state. Default is false"
     }
   },
   "required": [
diff --git a/api/src/main/resources/schema/transitions/transition.json b/api/src/main/resources/schema/transitions/transition.json
@@ -18,6 +18,11 @@
       "type": "string",
       "description": "State to transition to next",
       "minLength": 1
+    },
+    "compensate": {
+      "type": "boolean",
+      "default": false,
+      "description": "If set to true, triggers workflow compensation before this transition is taken. Default is false"
     }
   },
   "required": [
diff --git a/api/src/test/java/io/serverlessworkflow/api/test/MarkupToWorkflowTest.java b/api/src/test/java/io/serverlessworkflow/api/test/MarkupToWorkflowTest.java
@@ -17,12 +17,14 @@
 package io.serverlessworkflow.api.test;
 
 import io.serverlessworkflow.api.Workflow;
+import io.serverlessworkflow.api.interfaces.State;
+import io.serverlessworkflow.api.states.EventState;
+import io.serverlessworkflow.api.states.OperationState;
 import io.serverlessworkflow.api.test.utils.WorkflowTestUtils;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.ValueSource;
 
-import static org.junit.jupiter.api.Assertions.assertNotNull;
-import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.api.Assertions.*;
 
 public class MarkupToWorkflowTest {
 
@@ -74,7 +76,7 @@ public void testSpecFreatureFunctionRef(String workflowLocation) {
     }
 
     @ParameterizedTest
-    @ValueSource(strings = {"/features/vetappointment.json"})
+    @ValueSource(strings = {"/features/vetappointment.json", "/features/vetappointment.yml"})
     public void testSpecFreatureEventRef(String workflowLocation) {
         Workflow workflow = Workflow.fromSource(WorkflowTestUtils.readWorkflowFile(workflowLocation));
 
@@ -90,4 +92,29 @@ public void testSpecFreatureEventRef(String workflowLocation) {
         assertNotNull(workflow.getRetries());
         assertTrue(workflow.getRetries().getRetryDefs().size() == 1);
     }
+
+    @ParameterizedTest
+    @ValueSource(strings = {"/features/compensationworkflow.json", "/features/compensationworkflow.yml"})
+    public void testSpecFreatureCompensation(String workflowLocation) {
+        Workflow workflow = Workflow.fromSource(WorkflowTestUtils.readWorkflowFile(workflowLocation));
+
+        assertNotNull(workflow);
+        assertNotNull(workflow.getId());
+        assertNotNull(workflow.getName());
+        assertNotNull(workflow.getStates());
+
+        assertNotNull(workflow.getStates());
+        assertTrue(workflow.getStates().size() == 2);
+
+        State firstState = workflow.getStates().get(0);
+        assertTrue(firstState instanceof EventState);
+        assertNotNull(firstState.getCompensatedBy());
+        assertEquals("CancelPurchase", firstState.getCompensatedBy());
+
+        State secondState = workflow.getStates().get(1);
+        assertTrue(secondState instanceof OperationState);
+        OperationState operationState = (OperationState) secondState;
+
+        assertTrue(operationState.isUsedForCompensation());
+    }
 }
diff --git a/api/src/test/resources/features/compensationworkflow.json b/api/src/test/resources/features/compensationworkflow.json
@@ -0,0 +1,86 @@
+{
+  "id": "CompensationWorkflow",
+  "name": "Compensation Workflow",
+  "version": "1.0",
+  "states": [
+    {
+      "name": "NewItemPurchase",
+      "type": "event",
+      "onEvents": [
+        {
+          "eventRefs": [
+            "NewPurchase"
+          ],
+          "actions": [
+            {
+              "functionRef": {
+                "refName": "DebitCustomerFunction",
+                "parameters": {
+                  "customerid": "{{ $.purchase.customerid }}",
+                  "amount": "{{ $.purchase.amount }}"
+                }
+              }
+            },
+            {
+              "functionRef": {
+                "refName": "SendPurchaseConfirmationEmailFunction",
+                "parameters": {
+                  "customerid": "{{ $.purchase.customerid }}"
+                }
+              }
+            }
+          ]
+        }
+      ],
+      "compensatedBy": "CancelPurchase",
+      "transition": {
+        "nextState": "SomeNextWorkflowState"
+      }
+    },
+    {
+      "name": "CancelPurchase",
+      "type": "operation",
+      "usedForCompensation": true,
+      "actions": [
+        {
+          "functionRef": {
+            "refName": "CreditCustomerFunction",
+            "parameters": {
+              "customerid": "{{ $.purchase.customerid }}",
+              "amount": "{{ $.purchase.amount }}"
+            }
+          }
+        },
+        {
+          "functionRef": {
+            "refName": "SendPurchaseCancellationEmailFunction",
+            "parameters": {
+              "customerid": "{{ $.purchase.customerid }}"
+            }
+          }
+        }
+      ]
+    }
+  ],
+  "events": [
+    {
+      "name": "NewItemPurchase",
+      "source": "purchasesource",
+      "type": "org.purchases"
+    }
+  ],
+  "functions": [
+    {
+      "name": "DebitCustomerFunction",
+      "operation": "http://myapis.org/application.json#debit"
+    },
+    {
+      "name": "SendPurchaseConfirmationEmailFunction",
+      "operation": "http://myapis.org/application.json#confirmationemail"
+    },
+    {
+      "name": "SendPurchaseCancellationEmailFunction",
+      "operation": "http://myapis.org/application.json#cancellationemail"
+    }
+  ]
+}
diff --git a/api/src/test/resources/features/compensationworkflow.yml b/api/src/test/resources/features/compensationworkflow.yml
@@ -0,0 +1,46 @@
+id: CompensationWorkflow
+name: Compensation Workflow
+version: '1.0'
+states:
+  - name: NewItemPurchase
+    type: event
+    onEvents:
+      - eventRefs:
+          - NewPurchase
+        actions:
+          - functionRef:
+              refName: DebitCustomerFunction
+              parameters:
+                customerid: "{{ $.purchase.customerid }}"
+                amount: "{{ $.purchase.amount }}"
+          - functionRef:
+              refName: SendPurchaseConfirmationEmailFunction
+              parameters:
+                customerid: "{{ $.purchase.customerid }}"
+    compensatedBy: CancelPurchase
+    transition:
+      nextState: SomeNextWorkflowState
+  - name: CancelPurchase
+    type: operation
+    usedForCompensation: true
+    actions:
+      - functionRef:
+          refName: CreditCustomerFunction
+          parameters:
+            customerid: "{{ $.purchase.customerid }}"
+            amount: "{{ $.purchase.amount }}"
+      - functionRef:
+          refName: SendPurchaseCancellationEmailFunction
+          parameters:
+            customerid: "{{ $.purchase.customerid }}"
+events:
+  - name: NewItemPurchase
+    source: purchasesource
+    type: org.purchases
+functions:
+  - name: DebitCustomerFunction
+    operation: http://myapis.org/application.json#debit
+  - name: SendPurchaseConfirmationEmailFunction
+    operation: http://myapis.org/application.json#confirmationemail
+  - name: SendPurchaseCancellationEmailFunction
+    operation: http://myapis.org/application.json#cancellationemail

Original file line number	Diff line number	Diff line change
`@@ -48,5 +48,7 @@ public interface State {`
`48`	`48`
`49`	`49`	`List<Error> getOnErrors();`
`50`	`50`
	`51`	`+ String getCompensatedBy();`
	`52`	`+`
`51`	`53`	`Map<String, String> getMetadata();`
`52`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,11 @@`
`20`	`20`	`"type": "object",`
`21`	`21`	`"$ref": "../produce/produceevent.json"`
`22`	`22`	`}`
	`23`	`+ },`
	`24`	`+ "compensate": {`
	`25`	`+ "type": "boolean",`
	`26`	`+ "default": false,`
	`27`	`+ "description": "If set to true, triggers workflow compensation when before workflow executin completes. Default is false"`
`23`	`28`	`}`
`24`	`29`	`},`
`25`	`30`	`"required": [`
Original file line number	Diff line number	Diff line change
`@@ -64,6 +64,11 @@`
`64`	`64`	`"type": "object",`
`65`	`65`	`"$ref": "../error/error.json"`
`66`	`66`	`}`
	`67`	`+ },`
	`68`	`+ "compensatedBy": {`
	`69`	`+ "type": "string",`
	`70`	`+ "minLength": 1,`
	`71`	`+ "description": "Unique Name of a workflow state which is responsible for compensation of this state"`
`67`	`72`	`}`
`68`	`73`	`},`
`69`	`74`	`"required": [`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,11 @@`
`24`	`24`	`"type": "object",`
`25`	`25`	`"$ref": "../actions/action.json"`
`26`	`26`	`}`
	`27`	`+ },`
	`28`	`+ "usedForCompensation": {`
	`29`	`+ "type": "boolean",`
	`30`	`+ "default": false,`
	`31`	`+ "description": "If true, this state is used to compensate another state. Default is false"`
`27`	`32`	`}`
`28`	`33`	`},`
`29`	`34`	`"required": [`