Merge pull request #117 from tsurdilo/sleepstateup

tsurdilo · web-flow · commit ae1d508420fa · 2021-09-04T16:27:26.000-04:00
Delay/Sleep state updates
diff --git a/api/src/main/java/io/serverlessworkflow/api/deserializers/StateDeserializer.java b/api/src/main/java/io/serverlessworkflow/api/deserializers/StateDeserializer.java
@@ -80,9 +80,9 @@ public State deserialize(JsonParser jp,
             case SWITCH:
                 return mapper.treeToValue(node,
                         SwitchState.class);
-            case DELAY:
+            case SLEEP:
                 return mapper.treeToValue(node,
-                        DelayState.class);
+                        SleepState.class);
             case PARALLEL:
                 return mapper.treeToValue(node,
                         ParallelState.class);
diff --git a/api/src/main/java/io/serverlessworkflow/api/mapper/WorkflowModule.java b/api/src/main/java/io/serverlessworkflow/api/mapper/WorkflowModule.java
@@ -63,7 +63,7 @@ public WorkflowModule(WorkflowPropertySource workflowPropertySource) {
     private void addDefaultSerializers() {
         addSerializer(new WorkflowSerializer());
         addSerializer(new EventStateSerializer());
-        addSerializer(new DelayStateSerializer());
+        addSerializer(new SleepStateSerializer());
         addSerializer(new OperationStateSerializer());
         addSerializer(new ParallelStateSerializer());
         addSerializer(new SwitchStateSerializer());
diff --git a/api/src/main/java/io/serverlessworkflow/api/serializers/SleepStateSerializer.java b/api/src/main/java/io/serverlessworkflow/api/serializers/SleepStateSerializer.java
@@ -21,31 +21,31 @@
 import com.fasterxml.jackson.databind.ser.std.StdSerializer;
 import com.fasterxml.jackson.databind.type.TypeFactory;
 import io.serverlessworkflow.api.states.DefaultState;
-import io.serverlessworkflow.api.states.DelayState;
+import io.serverlessworkflow.api.states.SleepState;
 
 import java.io.IOException;
 
-public class DelayStateSerializer extends StdSerializer<DelayState> {
+public class SleepStateSerializer extends StdSerializer<SleepState> {
 
-    public DelayStateSerializer() {
-        this(DelayState.class);
+    public SleepStateSerializer() {
+        this(SleepState.class);
     }
 
-    protected DelayStateSerializer(Class<DelayState> t) {
+    protected SleepStateSerializer(Class<SleepState> t) {
         super(t);
     }
 
     @Override
-    public void serialize(DelayState delayState,
+    public void serialize(SleepState delayState,
                           JsonGenerator gen,
                           SerializerProvider provider) throws IOException {
 
         // set defaults for delay state
-        delayState.setType(DefaultState.Type.DELAY);
+        delayState.setType(DefaultState.Type.SLEEP);
 
         // serialize after setting default bean values...
         BeanSerializerFactory.instance.createSerializer(provider,
-                TypeFactory.defaultInstance().constructType(DelayState.class)).serialize(delayState,
+                TypeFactory.defaultInstance().constructType(SleepState.class)).serialize(delayState,
                 gen,
                 provider);
     }
diff --git a/api/src/main/resources/schema/states/defaultstate.json b/api/src/main/resources/schema/states/defaultstate.json
@@ -22,7 +22,7 @@
         "event",
         "operation",
         "switch",
-        "delay",
+        "sleep",
         "parallel",
         "subflow",
         "inject",
diff --git a/api/src/main/resources/schema/states/sleepstate.json b/api/src/main/resources/schema/states/sleepstate.json
@@ -1,6 +1,6 @@
 {
   "type": "object",
-  "javaType": "io.serverlessworkflow.api.states.DelayState",
+  "javaType": "io.serverlessworkflow.api.states.SleepState",
   "javaInterfaces": [
     "io.serverlessworkflow.api.interfaces.State"
   ],
@@ -9,9 +9,9 @@
     "$ref": "defaultstate.json"
   },
   "properties": {
-    "timeDelay": {
+    "duration": {
       "type": "string",
-      "description": "Amount of time (ISO 8601 format) to delay"
+      "description": "Duration (ISO 8601 duration format) to sleep"
     },
     "usedForCompensation": {
       "type": "boolean",
@@ -20,6 +20,6 @@
     }
   },
   "required": [
-    "timeDelay"
+    "duration"
   ]
 }
diff --git a/api/src/main/resources/schema/workflow.json b/api/src/main/resources/schema/workflow.json
@@ -92,8 +92,8 @@
         "existingJavaType": "io.serverlessworkflow.api.interfaces.State",
         "anyOf": [
           {
-            "title": "Delay State",
-            "$ref": "states/delaystate.json"
+            "title": "Sleep State",
+            "$ref": "states/sleepstate.json"
           },
           {
             "title": "Event State",
diff --git a/api/src/test/java/io/serverlessworkflow/api/test/WorkflowToMarkupTest.java b/api/src/test/java/io/serverlessworkflow/api/test/WorkflowToMarkupTest.java
@@ -25,14 +25,14 @@
 import io.serverlessworkflow.api.produce.ProduceEvent;
 import io.serverlessworkflow.api.schedule.Schedule;
 import io.serverlessworkflow.api.start.Start;
-import io.serverlessworkflow.api.states.DelayState;
+import io.serverlessworkflow.api.states.SleepState;
 import io.serverlessworkflow.api.workflow.Events;
 import io.serverlessworkflow.api.workflow.Functions;
 import org.junit.jupiter.api.Test;
 
 import java.util.Arrays;
 
-import static io.serverlessworkflow.api.states.DefaultState.Type.DELAY;
+import static io.serverlessworkflow.api.states.DefaultState.Type.SLEEP;
 import static org.junit.jupiter.api.Assertions.*;
 
 public class WorkflowToMarkupTest {
@@ -44,22 +44,22 @@ public void testSingleState() {
                         new Schedule().withInterval("PT1S")
                 ))
                 .withStates(Arrays.asList(
-                        new DelayState().withName("delayState").withType(DELAY)
+                        new SleepState().withName("sleepState").withType(SLEEP)
                                 .withEnd(
                                         new End().withTerminate(true).withCompensate(true)
                                                 .withProduceEvents(Arrays.asList(
                                                         new ProduceEvent().withEventRef("someEvent")
                                                 ))
                                 )
-                                .withTimeDelay("PT1M")
+                                .withDuration("PT1M")
                         )
                 );
 
         assertNotNull(workflow);
         assertNotNull(workflow.getStart());
         assertEquals(1, workflow.getStates().size());
         State state = workflow.getStates().get(0);
-        assertTrue(state instanceof DelayState);
+        assertTrue(state instanceof SleepState);
         assertNotNull(state.getEnd());
 
         assertNotNull(Workflow.toJson(workflow));
@@ -78,19 +78,19 @@ public void testSingleFunction() {
                                 .withOperation("testSwaggerDef#testOperationId")))
                 )
                 .withStates(Arrays.asList(
-                        new DelayState().withName("delayState").withType(DELAY)
+                        new SleepState().withName("delayState").withType(SLEEP)
                                 .withEnd(
                                         new End()
                                 )
-                                .withTimeDelay("PT1M")
+                                .withDuration("PT1M")
                         )
                 );
 
         assertNotNull(workflow);
         assertNotNull(workflow.getStart());
         assertEquals(1, workflow.getStates().size());
         State state = workflow.getStates().get(0);
-        assertTrue(state instanceof DelayState);
+        assertTrue(state instanceof SleepState);
         assertNotNull(workflow.getFunctions());
         assertEquals(1, workflow.getFunctions().getFunctionDefs().size());
         assertEquals("testFunction", workflow.getFunctions().getFunctionDefs().get(0).getName());
@@ -115,19 +115,19 @@ public void testSingleEvent() {
                                 .withOperation("testSwaggerDef#testOperationId")))
                 )
                 .withStates(Arrays.asList(
-                        new DelayState().withName("delayState").withType(DELAY)
+                        new SleepState().withName("delayState").withType(SLEEP)
                                 .withEnd(
                                         new End()
                                 )
-                                .withTimeDelay("PT1M")
+                                .withDuration("PT1M")
                         )
                 );
 
         assertNotNull(workflow);
         assertNotNull(workflow.getStart());
         assertEquals(1, workflow.getStates().size());
         State state = workflow.getStates().get(0);
-        assertTrue(state instanceof DelayState);
+        assertTrue(state instanceof SleepState);
         assertNotNull(workflow.getFunctions());
         assertEquals(1, workflow.getFunctions().getFunctionDefs().size());
         assertEquals("testFunction", workflow.getFunctions().getFunctionDefs().get(0).getName());
diff --git a/api/src/test/resources/examples/booklending.json b/api/src/test/resources/examples/booklending.json
@@ -95,9 +95,9 @@
       "transition": "Wait two weeks"
     },
     {
-      "name": "Wait two weeks",
-      "type": "delay",
-      "timeDelay": "P2W",
+      "name": "Sleep two weeks",
+      "type": "sleep",
+      "duration": "P2W",
       "transition": "Get Book Status"
     },
     {
diff --git a/api/src/test/resources/examples/booklending.yml b/api/src/test/resources/examples/booklending.yml
@@ -55,8 +55,8 @@ states:
             lender: "${ .lender }"
     transition: Wait two weeks
   - name: Wait two weeks
-    type: delay
-    timeDelay: P2W
+    type: sleep
+    duration: P2W
     transition: Get Book Status
   - name: Check Out Book
     type: operation
diff --git a/api/src/test/resources/examples/jobmonitoring.json b/api/src/test/resources/examples/jobmonitoring.json
@@ -64,8 +64,8 @@
     },
     {
       "name": "WaitForCompletion",
-      "type": "delay",
-      "timeDelay": "PT5S",
+      "type": "sleep",
+      "duration": "PT5S",
       "transition": "GetJobStatus"
     },
     {
diff --git a/api/src/test/resources/examples/jobmonitoring.yml b/api/src/test/resources/examples/jobmonitoring.yml
@@ -36,8 +36,8 @@ states:
       - subFlowRef: handleJobSubmissionErrorWorkflow
     end: true
   - name: WaitForCompletion
-    type: delay
-    timeDelay: PT5S
+    type: sleep
+    duration: PT5S
     transition: GetJobStatus
   - name: GetJobStatus
     type: operation
diff --git a/diagram/src/main/java/io/serverlessworkflow/diagram/model/WorkflowDiagramModel.java b/diagram/src/main/java/io/serverlessworkflow/diagram/model/WorkflowDiagramModel.java
@@ -304,11 +304,11 @@ private void inspectStatesInfo(Workflow workflow) {
 
             }
 
-            if (state instanceof DelayState) {
-                DelayState delayState = (DelayState) state;
+            if (state instanceof SleepState) {
+                SleepState sleepState = (SleepState) state;
 
-                modelState.addInfo("Type: Delay State");
-                modelState.addInfo("Delay: " + delayState.getTimeDelay());
+                modelState.addInfo("Type: Sleep State");
+                modelState.addInfo("Duration: " + sleepState.getDuration());
             }
 
             if (state instanceof ParallelState) {
diff --git a/diagram/src/main/resources/templates/plantuml/workflow-template.txt b/diagram/src/main/resources/templates/plantuml/workflow-template.txt
@@ -13,7 +13,7 @@ skinparam state {
   BorderColor<< event >> #7fe5f0
   BorderColor<< operation >> #bada55
   BorderColor<< switch >> #92a0f2
-  BorderColor<< delay >> #b83b5e
+  BorderColor<< sleep >> #b83b5e
   BorderColor<< parallel >> #6a2c70
   BorderColor<< inject >> #1e5f74
   BorderColor<< foreach >> #931a25
@@ -38,7 +38,7 @@ state "[(${diagram.title})]" as workflow << workflow >> {
 [# th:if="${diagram.showLegend}" ]
 legend center
 State Types and Border Colors:
-| Event | Operation | Switch | Delay | Parallel | Inject | ForEach | CallBack |
+| Event | Operation | Switch | Sleep | Parallel | Inject | ForEach | CallBack |
 |<#7fe5f0>|<#bada55>|<#92a0f2>|<#b83b5e>|<#6a2c70>|<#1e5f74>|<#931a25>|<#ffcb8e>|
 endlegend
 [/]
diff --git a/diagram/src/test/resources/examples/booklending.json b/diagram/src/test/resources/examples/booklending.json
@@ -96,8 +96,8 @@
     },
     {
       "name": "Wait two weeks",
-      "type": "delay",
-      "timeDelay": "P2W",
+      "type": "sleep",
+      "duration": "P2W",
       "transition": "Get Book Status"
     },
     {
diff --git a/diagram/src/test/resources/examples/booklending.yml b/diagram/src/test/resources/examples/booklending.yml
@@ -55,8 +55,8 @@ states:
             lender: "${ .lender }"
     transition: Wait two weeks
   - name: Wait two weeks
-    type: delay
-    timeDelay: P2W
+    type: sleep
+    duration: P2W
     transition: Get Book Status
   - name: Check Out Book
     type: operation
diff --git a/diagram/src/test/resources/examples/jobmonitoring.json b/diagram/src/test/resources/examples/jobmonitoring.json
@@ -64,8 +64,8 @@
     },
     {
       "name": "WaitForCompletion",
-      "type": "delay",
-      "timeDelay": "PT5S",
+      "type": "sleep",
+      "duration": "PT5S",
       "transition": "GetJobStatus"
     },
     {
diff --git a/diagram/src/test/resources/examples/jobmonitoring.yml b/diagram/src/test/resources/examples/jobmonitoring.yml
@@ -36,8 +36,8 @@ states:
       - subFlowRef: handleJobSubmissionErrorWorkflow
     end: true
   - name: WaitForCompletion
-    type: delay
-    timeDelay: PT5S
+    type: sleep
+    duration: PT5S
     transition: GetJobStatus
   - name: GetJobStatus
     type: operation
diff --git a/diagram/src/test/resources/examples/singleswitchstate.json b/diagram/src/test/resources/examples/singleswitchstate.json
@@ -34,8 +34,8 @@
     },
     {
       "name": "FromFirstCondition",
-      "type": "delay",
-      "timeDelay": "PT2M",
+      "type": "sleep",
+      "duration": "PT2M",
       "end": true
     },
     {
diff --git a/diagram/src/test/resources/examples/singleswitchstate.yml b/diagram/src/test/resources/examples/singleswitchstate.yml
@@ -22,8 +22,8 @@ states:
         condition: ''
         end: true
   - name: FromFirstCondition
-    type: delay
-    timeDelay: PT2M
+    type: sleep
+    duration: PT2M
     end: true
   - name: FromSecondCondition
     type: inject
diff --git a/diagram/src/test/resources/examples/singleswitchstateeventconditions.json b/diagram/src/test/resources/examples/singleswitchstateeventconditions.json
@@ -34,8 +34,8 @@
     },
     {
       "name": "FromFirstCondition",
-      "type": "delay",
-      "timeDelay": "PT2M",
+      "type": "sleep",
+      "duration": "PT2M",
       "end": true
     },
     {
diff --git a/diagram/src/test/resources/examples/singleswitchstateeventconditions.yml b/diagram/src/test/resources/examples/singleswitchstateeventconditions.yml
@@ -22,8 +22,8 @@ states:
         eventRef: fourthEvent
         end: true
   - name: FromFirstCondition
-    type: delay
-    timeDelay: PT2M
+    type: sleep
+    duration: PT2M
     end: true
   - name: FromSecondCondition
     type: inject
diff --git a/validation/src/main/java/io/serverlessworkflow/validation/WorkflowValidatorImpl.java b/validation/src/main/java/io/serverlessworkflow/validation/WorkflowValidatorImpl.java
@@ -298,10 +298,10 @@ public List<ValidationError> validate() {
                         }
                     }
 
-                    if (s instanceof DelayState) {
-                        DelayState delayState = (DelayState) s;
-                        if (delayState.getTimeDelay() == null || delayState.getTimeDelay().length() < 1) {
-                            addValidationError("Delay state should have a non-empty time delay",
+                    if (s instanceof SleepState) {
+                        SleepState sleepState = (SleepState) s;
+                        if (sleepState.getDuration() == null || sleepState.getDuration().length() < 1) {
+                            addValidationError("Sleep state should have a non-empty time delay",
                                     ValidationError.WORKFLOW_VALIDATION);
                         }
                     }
diff --git a/validation/src/test/java/io/serverlessworkflow/validation/test/WorkflowValidationTest.java b/validation/src/test/java/io/serverlessworkflow/validation/test/WorkflowValidationTest.java

Original file line number	Diff line number	Diff line change
`@@ -92,8 +92,8 @@`
`92`	`92`	`"existingJavaType": "io.serverlessworkflow.api.interfaces.State",`
`93`	`93`	`"anyOf": [`
`94`	`94`	`{`
`95`		`- "title": "Delay State",`
`96`		`- "$ref": "states/delaystate.json"`
	`95`	`+ "title": "Sleep State",`
	`96`	`+ "$ref": "states/sleepstate.json"`
`97`	`97`	`},`
`98`	`98`	`{`
`99`	`99`	`"title": "Event State",`
Original file line number	Diff line number	Diff line change
`@@ -95,9 +95,9 @@`
`95`	`95`	`"transition": "Wait two weeks"`
`96`	`96`	`},`
`97`	`97`	`{`
`98`		`- "name": "Wait two weeks",`
`99`		`- "type": "delay",`
`100`		`- "timeDelay": "P2W",`
	`98`	`+ "name": "Sleep two weeks",`
	`99`	`+ "type": "sleep",`
	`100`	`+ "duration": "P2W",`
`101`	`101`	`"transition": "Get Book Status"`
`102`	`102`	`},`
`103`	`103`	`{`
Original file line number	Diff line number	Diff line change
`@@ -64,8 +64,8 @@`
`64`	`64`	`},`
`65`	`65`	`{`
`66`	`66`	`"name": "WaitForCompletion",`
`67`		`- "type": "delay",`
`68`		`- "timeDelay": "PT5S",`
	`67`	`+ "type": "sleep",`
	`68`	`+ "duration": "PT5S",`
`69`	`69`	`"transition": "GetJobStatus"`
`70`	`70`	`},`
`71`	`71`	`{`