Adding async function invocation capability (#501)

* Adding async function invocation capability

Signed-off-by: Tihomir Surdilovic <[email protected]>

* fix typo

Signed-off-by: Tihomir Surdilovic <[email protected]>

Author: tsurdilo

examples/README.md

@@ -9,6 +9,8 @@ Provides Serverless Workflow language examples
 - [Event-based greeting (Event State)](#Event-Based-Greeting-Example)
 - [Solving Math Problems (ForEach state)](#Solving-Math-Problems-Example)
 - [Parallel Execution](#Parallel-Execution-Example)
+- [Async Function Invocation](#Async-Function-Invocation-Example)
+- [Async SubFlow Invocation](#Async-SubFlow-Invocation-Example)
 - [Event Based Transitions (Event-based Switch)](#Event-Based-Transitions-Example)
 - [Applicant Request Decision (Data-based Switch + SubFlows)](#Applicant-Request-Decision-Example)
 - [Provision Orders (Error Handling)](#Provision-Orders-Example)
@@ -580,6 +582,179 @@ We assume that the two referenced workflows, namely `shortdelayworkflowid` and `
 with the `shortdelayworkflowid` workflow delay state defining its `timeDelay` property to be shorter than that of the `longdelayworkflowid` workflows
 delay state.
 
+### Async Function Invocation Example
+
+#### Description
+
+This example uses a [Operation State](../specification.md#operation-state) to invoke a function async. 
+This functions sends an email to a customer.
+Async function execution is a "fire-and-forget" type of invocation. The function is invoked and workflow execution
+does not wait for its results.
+
+#### Workflow Diagram
+
+<p align="center">
+<img src="../media/examples/example-asyncfunction.png" height="500px" alt="Async Function Example"/>
+</p>
+
+#### Workflow Definition
+
+<table>
+<tr>
+    <th>JSON</th>
+    <th>YAML</th>
+</tr>
+<tr>
+<td valign="top">
+
+```json
+{
+ "id": "sendcustomeremail",
+ "version": "1.0",
+ "specVersion": "0.7",
+ "name": "Send customer email workflow",
+ "description": "Send email to a customer",
+ "start": "Send Email",
+ "functions": [
+  {
+   "name": "emailFunction",
+   "operation": "file://myapis/emailapis.json#sendEmail"
+  }
+ ],
+ "states":[
+  {
+   "name":"Send Email",
+   "type":"operation",
+   "actions":[
+    {
+     "functionRef": {
+      "invoke": "async",
+      "refName": "emailFunction",
+      "arguments": {
+       "customer": "${ .customer }"
+      }
+     }
+    }
+   ],
+   "end": true
+  }
+ ]
+}
+```
+
+</td>
+<td valign="top">
+
+```yaml
+id: sendcustomeremail
+version: '1.0'
+specVersion: '0.7'
+name: Send customer email workflow
+description: Send email to a customer
+start: Send Email
+functions:
+ - name: emailFunction
+   operation: file://myapis/emailapis.json#sendEmail
+states:
+ - name: Send Email
+   type: operation
+   actions:
+    - functionRef:
+       invoke: async
+       refName: emailFunction
+       arguments:
+        customer: "${ .customer }"
+   end: true
+```
+
+</td>
+</tr>
+</table>
+
+### Async SubFlow Invocation Example
+
+#### Description
+
+This example uses a [Operation State](../specification.md#operation-state) to invoke a [SubFlow](../specification.md#Subflow-Action) async.
+This SubFlow is responsible for performing some customer business logic.
+Async SubFlow invocation is a "fire-and-forget" type of invocation. The SubFlow is invoked and workflow execution
+does not wait for its results. In addition, we specify that the SubFlow should be allowed to continue its execution 
+event if the parent workflow completes its own execution. This is done by defining the actions `onParentComplete`
+property to `continue`.
+
+#### Workflow Diagram
+
+<p align="center">
+<img src="../media/examples/example-asyncsubflow.png" height="500px" alt="Async SubFlow Example"/>
+</p>
+
+#### Workflow Definition
+
+<table>
+<tr>
+    <th>JSON</th>
+    <th>YAML</th>
+</tr>
+<tr>
+<td valign="top">
+
+```json
+{
+ "id": "onboardcustomer",
+ "version": "1.0",
+ "specVersion": "0.7",
+ "name": "Onboard Customer",
+ "description": "Onboard a Customer",
+ "start": "Onboard",
+ "states":[
+  {
+   "name":"Onboard", 
+   "type":"operation",
+   "actions":[
+    {
+     "subFlowRef": {
+      "invoke": "async",
+      "onParentComplete": "continue",
+      "workflowId": "customeronboardingworkflow",
+      "version": "1.0"
+     }
+    }
+   ],
+   "end": true
+  }
+ ]
+}
+```
+
+</td>
+<td valign="top">
+
+```yaml
+id: onboardcustomer
+version: '1.0'
+specVersion: '0.7'
+name: Onboard Customer
+description: Onboard a Customer
+start: Onboard
+states:
+ - name: Onboard
+   type: operation
+   actions:
+    - subFlowRef:
+       invoke: async
+       onParentComplete: continue
+       workflowId: customeronboardingworkflow
+       version: '1.0'
+   end: true
+```
+
+</td>
+</tr>
+</table>
+
+For the sake of the example, the definition of "customeronboardingworkflow" workflow invoked as a SubFlow 
+is not shown. 
+
 ### Event Based Transitions Example
 
 #### Description

media/examples/example-asyncfunction.png

@@ -29,7 +29,7 @@ _Status description:_
 | ✔️| Added "useData" for eventDataFilter, and "useResults" for actionDataFilter | [spec doc](https://github.com/serverlessworkflow/specification/blob/main/specification.md)  |
 | ✔️| Added "resultEventTimeout" for action eventref | [spec doc](https://github.com/serverlessworkflow/specification/blob/main/specification.md)  |
 | ✔️| Added example for "continueAs" | [examples doc](https://github.com/serverlessworkflow/specification/blob/main/examples/README.md)  |
-| ✏️️| Support for async action invocation |   |
+| ✔️️| Support for async action invocation | [spec doc](https://github.com/serverlessworkflow/specification/blob/main/specification.md)  |
 | ✏️️| Add "completedBy" functionality |   |
 | ✏️️| Define workflow context |   |
 | ✏️️| Start work on TCK  |   |

media/examples/example-asyncsubflow.png

@@ -418,6 +418,10 @@
     "action": {
       "type": "object",
       "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique action identifier"
+        },
         "name": {
           "type": "string",
           "description": "Unique action definition name"
@@ -506,6 +510,15 @@
             "selectionSet": {
               "type": "string",
               "description": "Only used if function type is 'graphql'. A string containing a valid GraphQL selection set"
+            },
+            "invoke": {
+              "type": "string",
+              "enum": [
+                "sync",
+                "async"
+              ],
+              "description": "Specifies if the function should be invoked sync or async",
+              "default": "sync"
             }
           },
           "additionalProperties": false,
@@ -544,6 +557,15 @@
           "additionalProperties": {
             "type": "string"
           }
+        },
+        "invoke": {
+          "type": "string",
+          "enum": [
+            "sync",
+            "async"
+          ],
+          "description": "Specifies if the function should be invoked sync or async. Default is sync.",
+          "default": "sync"
         }
       },
       "additionalProperties": false,
@@ -571,6 +593,24 @@
               "type": "string",
               "description": "Version of the sub-workflow to be invoked",
               "minLength": 1
+            },
+            "onParentComplete": {
+              "type": "string",
+              "enum": [
+                "continue",
+                "terminate"
+              ],
+              "description": "If invoke is 'async', specifies how subflow execution should behave when parent workflow completes. Default is 'terminate'",
+              "default": "terminate"
+            },
+            "invoke": {
+              "type": "string",
+              "enum": [
+                "sync",
+                "async"
+              ],
+              "description": "Specifies if the subflow should be invoked sync or async",
+              "default": "sync"
             }
           },
           "required": [