[Fix #686] Remove sleep state

fjtirado · fjtirado · commit df70655caab9 · 2024-03-18T12:19:37.000+01:00
Removing sleep state, as it is redundant with sleep after and before

Signed-off-by: Francisco Javier Tirado Sarti &lt;ftirados@redhat.com&gt;
diff --git a/examples/book-lending.json b/examples/book-lending.json
@@ -5,6 +5,7 @@
     "version": "1.0.0",
     "specVersion": "0.8",
     "start": "book-lending-request",
+    "constants" : { "WAIT_BEFORE_POLL" : "PT2W"},
     "states": [
         {
             "name": "book-lending-request",
@@ -101,10 +102,13 @@
                             "bookid": "${ .book.id }",
                             "lender": "${ .lender }"
                         }
+                    }, 
+                    "sleep" : {
+                      "after" : "$CONST.WAIT_BEFORE_POLL"
                     }
                 }
             ],
-            "transition": "sleep-two-weeks"
+            "transition": "get-book-status"
         },
         {
             "name": "cancel-request",
@@ -118,15 +122,12 @@
                             "bookid": "${ .book.id }",
                             "lender": "${ .lender }"
                         }
+                    }, 
+                    "sleep" : {
+                      "after" : "$CONST.WAIT_BEFORE_POLL"
                     }
                 }
             ],
-            "transition": "sleep-two-weeks"
-        },
-        {
-            "name": "sleep-two-weeks",
-            "type": "sleep",
-            "duration": "PT2W",
             "transition": "get-book-status"
         },
         {
diff --git a/examples/monitor-job.json b/examples/monitor-job.json
@@ -45,12 +45,6 @@
             "stateDataFilter": {
                 "output": "${ .jobuid }"
             },
-            "transition": "wait-for-completion"
-        },
-        {
-            "name": "wait-for-completion",
-            "type": "sleep",
-            "duration": "PT5S",
             "transition": "get-job-status"
         },
         {
@@ -68,6 +62,9 @@
                     },
                     "actionDataFilter": {
                         "results": "${ .jobstatus }"
+                    },
+                    "sleep" : {
+                      "before": "PT5S"
                     }
                 }
             ],
@@ -92,7 +89,7 @@
                 }
             ],
             "defaultCondition": {
-                "transition": "wait-for-completion"
+                "transition": "get-job-status"
             }
         },
         {
diff --git a/schema/workflow.json b/schema/workflow.json
@@ -113,10 +113,6 @@
       "description": "State definitions",
       "items": {
         "anyOf": [
-          {
-            "title": "Sleep State",
-            "$ref": "#/definitions/sleepstate"
-          },
           {
             "title": "Event State",
             "$ref": "#/definitions/eventstate"
@@ -643,56 +639,6 @@
         "actions"
       ]
     },
-    "sleepstate": {
-      "type": "object",
-      "description": "Causes the workflow execution to sleep for a specified duration",
-      "properties": {
-        "name": {
-          "type": "string",
-          "description": "State name",
-          "pattern": "^[a-z0-9](-?[a-z0-9])*$"
-        },
-        "type": {
-          "type": "string",
-          "const": "sleep",
-          "description": "State type"
-        },
-        "end": {
-          "$ref": "#/definitions/end",
-          "description": "State end definition"
-        },
-        "duration": {
-          "type": "string",
-          "description": "Duration (literal ISO 8601 duration format or expression which evaluation results in an ISO 8601 duration) to sleep"
-        },
-        "transition": {
-          "description": "Next transition of the workflow after the workflow sleep",
-          "$ref": "#/definitions/transition"
-        },
-        "metadata": {
-          "$ref": "common.json#/definitions/metadata"
-        }
-      },
-      "additionalProperties": false,
-      "oneOf": [
-        {
-          "required": [
-            "name",
-            "type",
-            "duration",
-            "end"
-          ]
-        },
-        {
-          "required": [
-            "name",
-            "type",
-            "duration",
-            "transition"
-          ]
-        }
-      ]
-    },
     "eventstate": {
       "type": "object",
       "description": "This state is used to wait for events from event sources, then consumes them and invoke one or more actions to run in sequence or parallel",
diff --git a/specification.md b/specification.md
@@ -41,7 +41,6 @@
       - [Event State](#event-state)
       - [Operation State](#operation-state)
       - [Switch State](#switch-state)
-      - [Sleep State](#sleep-state)
       - [Parallel State](#parallel-state)
       - [Inject State](#inject-state)
       - [ForEach State](#foreach-state)
@@ -2289,7 +2288,6 @@ Serverless Workflow defines the following Workflow States:
 | **[Event](#Event-State)** | Define events that trigger action execution | yes | yes | yes | yes | yes | no | yes | yes |
 | **[Operation](#Operation-State)** | Execute one or more actions | no | yes | yes | yes | yes | no | yes | yes |
 | **[Switch](#Switch-State)** | Define data-based or event-based workflow transitions | no | yes | no | yes | no | yes | yes | no |
-| **[Sleep](#Sleep-State)** | Sleep workflow execution for a specific time duration | no | yes | no | yes | no | no | yes | yes |
 | **[Parallel](#Parallel-State)** | Causes parallel execution of branches (set of states) | no | yes | no | yes | yes | no | yes | yes |
 | **[Inject](#Inject-State)** | Inject static data into state data | no | yes | no | yes | no | no | yes | yes |
 | **[ForEach](#ForEach-State)** | Parallel execution of states for each element of a data array | no | yes | no | yes | yes | no | yes | yes |
@@ -2617,57 +2615,6 @@ The `timeouts` property can be used to define state specific timeout settings. S
 `stateExecTimeout` setting. If `eventConditions` is defined, the switch state can also define the
 `eventTimeout` property. For more information on workflow timeouts reference the [Workflow Timeouts](#Workflow-Timeouts) section.
 
-##### Sleep State
-
-| Parameter | Description | Type | Required |
-| --- | --- | --- | --- |
-| name | Unique State name. Must follow the [Serverless Workflow Naming Convention](#naming-convention) | string | yes |
-| type | State type | string | yes |
-| duration | Duration (ISO 8601 literal duration or an expression which evaluation results in an ISO 8601 duration) to sleep. For example: "PT15M" (sleep 15 minutes), or "P2DT3H4M" (sleep 2 days, 3 hours and 4 minutes), or $CONST.timeout, where timeout value is "PT15M" | string | yes |
-| [transition](#Transitions) | Next transition of the workflow after the sleep | string or object | yes (if `end` is not defined) |
-| [end](#End-Definition) | Is this state an end state | boolean or object | yes (if `transition` is not defined) |
-
-<details><summary><strong>Click to view example definition</strong></summary>
-<p>
-
-<table>
-<tr>
-    <th>JSON</th>
-    <th>YAML</th>
-</tr>
-<tr>
-<td valign="top">
-
-```json
-{
-      "name": "sleep-five-seconds",
-      "type": "sleep",
-      "duration": "PT5S",
-      "transition": "get-job-status"
-}
-```
-
-</td>
-<td valign="top">
-
-```yaml
-name: sleep-five-seconds
-type: sleep
-duration: PT5S
-transition: get-job-status
-```
-
-</td>
-</tr>
-</table>
-
-</details>
-
-Sleep state 
-suspends workflow execution for a given time duration. The delay is defined in its `duration` property using the ISO 8601 
-duration format. Note that ISO 8601 can be the result of evaluating an expression. 
-
-Note that `transition` and `end` properties are mutually exclusive, meaning that you cannot define both of them at the same time.
 ##### Parallel State
 
 | Parameter | Description | Type | Required |
@@ -5739,7 +5686,7 @@ not obeyed in the workflow definition.
 
 #### States Timeout Definition
 
-All workflow states except Sleep and Inject States can define the `timeouts` property and can define different timeout
+All workflow states except Inject State can define the `timeouts` property and can define different timeout
 settings depending on their state type.
 Please reference each [workflow state definitions](#Workflow-States) for more information on which
 timeout settings are available for each state type.

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`"version": "1.0.0",`
`6`	`6`	`"specVersion": "0.8",`
`7`	`7`	`"start": "book-lending-request",`
	`8`	`+ "constants" : { "WAIT_BEFORE_POLL" : "PT2W"},`
`8`	`9`	`"states": [`
`9`	`10`	`{`
`10`	`11`	`"name": "book-lending-request",`
`@@ -101,10 +102,13 @@`
`101`	`102`	`"bookid": "${ .book.id }",`
`102`	`103`	`"lender": "${ .lender }"`
`103`	`104`	`}`
	`105`	`+ },`
	`106`	`+ "sleep" : {`
	`107`	`+ "after" : "$CONST.WAIT_BEFORE_POLL"`
`104`	`108`	`}`
`105`	`109`	`}`
`106`	`110`	`],`
`107`		`- "transition": "sleep-two-weeks"`
	`111`	`+ "transition": "get-book-status"`
`108`	`112`	`},`
`109`	`113`	`{`
`110`	`114`	`"name": "cancel-request",`
`@@ -118,15 +122,12 @@`
`118`	`122`	`"bookid": "${ .book.id }",`
`119`	`123`	`"lender": "${ .lender }"`
`120`	`124`	`}`
	`125`	`+ },`
	`126`	`+ "sleep" : {`
	`127`	`+ "after" : "$CONST.WAIT_BEFORE_POLL"`
`121`	`128`	`}`
`122`	`129`	`}`
`123`	`130`	`],`
`124`		`- "transition": "sleep-two-weeks"`
`125`		`- },`
`126`		`- {`
`127`		`- "name": "sleep-two-weeks",`
`128`		`- "type": "sleep",`
`129`		`- "duration": "PT2W",`
`130`	`131`	`"transition": "get-book-status"`
`131`	`132`	`},`
`132`	`133`	`{`
Original file line number	Diff line number	Diff line change
`@@ -45,12 +45,6 @@`
`45`	`45`	`"stateDataFilter": {`
`46`	`46`	`"output": "${ .jobuid }"`
`47`	`47`	`},`
`48`		`- "transition": "wait-for-completion"`
`49`		`- },`
`50`		`- {`
`51`		`- "name": "wait-for-completion",`
`52`		`- "type": "sleep",`
`53`		`- "duration": "PT5S",`
`54`	`48`	`"transition": "get-job-status"`
`55`	`49`	`},`
`56`	`50`	`{`
`@@ -68,6 +62,9 @@`
`68`	`62`	`},`
`69`	`63`	`"actionDataFilter": {`
`70`	`64`	`"results": "${ .jobstatus }"`
	`65`	`+ },`
	`66`	`+ "sleep" : {`
	`67`	`+ "before": "PT5S"`
`71`	`68`	`}`
`72`	`69`	`}`
`73`	`70`	`],`
`@@ -92,7 +89,7 @@`
`92`	`89`	`}`
`93`	`90`	`],`
`94`	`91`	`"defaultCondition": {`
`95`		`- "transition": "wait-for-completion"`
	`92`	`+ "transition": "get-job-status"`
`96`	`93`	`}`
`97`	`94`	`},`
`98`	`95`	`{`