Adding subflow example using exclusive (#1918)

Co-authored-by: Gonzalo Muñoz <[email protected]>
apache · May 14, 2024 · a7fee00 · a7fee00
1 parent 5272325
commit a7fee00
Show file tree

Hide file tree

Showing 8 changed files with 527 additions and 0 deletions.
diff --git a/serverless-workflow-examples/serverless-workflow-subflows-event/README.md b/serverless-workflow-examples/serverless-workflow-subflows-event/README.md
@@ -0,0 +1,86 @@
+# serverless-workflow-subflow-events
+
+This example illustrate how to trigger workflows manually with additional parameters calculated by an initial workflow. 
+The workflow responsible for setting up the parameters is executed as the start state.
+Then, all possible workflows that might be instantiated with those parameters are registered using `event` state. `exclusive` property is set to false ensuring that the process instance remains active till all possible workflows has been executed. 
+
+## Execution steps. 
+
+Execute main workflow
+
+```
+curl --location 'http://localhost:8080/master' \
+--header 'Content-Type: application/json' \
+--data '{
+}'
+```
+
+This will return the id and the two properties that are configured by `setup` workflow
+
+```
+{
+    "id": "ad7e1081-3f05-431e-b246-d9471643fec2",
+    "workflowdata": {
+        "param1": "This is param1",
+        "param2": "This is param2"
+    }
+}
+```
+
+We need to write down the id returned by the previous steps and invoke `workflowA` through a cloud event containing that id as `kogitoprocrefid` attibute. 
+
+```
+curl --location 'http://localhost:8080/executeA' \
+--header 'Content-Type: application/json' \
+--data '{
+   "id" : "1",
+   "specversion" : "1.0",
+   "type" : "executeA",
+   "source" : "manual", 
+   "data" : {  
+     "param4" : "Additional parameter"
+   },
+   "kogitoprocrefid" : "ad7e1081-3f05-431e-b246-d9471643fec2"
+}'
+```
+
+The execution of `workflowA` is registered in the quarkus log. 
+
+```
+2024-05-14 12:09:10,306 INFO  [org.kie.kog.ser.wor.dev.DevModeServerlessWorkflowLogger] (kogito-event-executor-1) Triggered node 'Start' for process 'workflowA' (8321fbd0-64ee-4e95-91d6-957983a92325)
+2024-05-14 12:09:10,306 INFO  [org.kie.kog.ser.wor.dev.DevModeServerlessWorkflowLogger] (kogito-event-executor-1) Triggered node 'doIt' for process 'workflowA' (8321fbd0-64ee-4e95-91d6-957983a92325)
+2024-05-14 12:09:10,307 INFO  [org.kie.kog.ser.wor.dev.DevModeServerlessWorkflowLogger] (kogito-event-executor-1) Property 'workflowdata.param3' changed value from: 'null', to: '"This is workflow A"'
+2024-05-14 12:09:10,307 INFO  [org.kie.kog.ser.wor.dev.DevModeServerlessWorkflowLogger] (kogito-event-executor-1) Triggered node 'End' for process 'workflowA' (8321fbd0-64ee-4e95-91d6-957983a92325)
+```
+
+The main workflow is still active, waiting for execution of workflow B. Lets execute it sending another cloud event. 
+
+```
+curl --location 'http://localhost:8080/executeB' \
+--header 'Content-Type: application/json' \
+--data '{
+    "id": "1",
+    "specversion": "1.0",
+    "type": "executeB",
+    "source": "manual",
+    "data": {
+        "param4": "Additional parameter"
+    },
+    "kogitoprocrefid": "ad7e1081-3f05-431e-b246-d9471643fec2"
+}'
+```
+
+We  see in quarkus logs that workflow B is executed and that master workflow is completed, since there are not more waiting events
+
+```
+2024-05-14 12:09:10,334 INFO  [org.kie.kog.ser.wor.dev.DevModeServerlessWorkflowLogger] (kogito-event-executor-1) Triggered node 'Start' for process 'workflowB' (5a49f40d-2e54-46fb-8317-b0be12fd9f05)
+2024-05-14 12:09:10,334 INFO  [org.kie.kog.ser.wor.dev.DevModeServerlessWorkflowLogger] (kogito-event-executor-1) Triggered node 'doIt' for process 'workflowB' (5a49f40d-2e54-46fb-8317-b0be12fd9f05)
+2024-05-14 12:09:10,335 INFO  [org.kie.kog.ser.wor.dev.DevModeServerlessWorkflowLogger] (kogito-event-executor-1) Property 'workflowdata.param3' changed value from: 'null', to: '"This is workflow B"'
+2024-05-14 12:09:10,335 INFO  [org.kie.kog.ser.wor.dev.DevModeServerlessWorkflowLogger] (kogito-event-executor-1) Triggered node 'End' for process 'workflowB' (5a49f40d-2e54-46fb-8317-b0be12fd9f05)
+2024-05-14 12:09:10,335 INFO  [org.kie.kog.ser.wor.dev.DevModeServerlessWorkflowLogger] (kogito-event-executor-1) Workflow 'workflowB' (5a49f40d-2e54-46fb-8317-b0be12fd9f05) completed
+2024-05-14 12:09:10,336 INFO  [org.jbp.pro.cor.eve.EventTypeFilter] (kogito-event-executor-1) This event is subscribed to a message ref processInstanceCompleted:5a49f40d-2e54-46fb-8317-b0be12fd9f05 WorkflowProcessInstance [Id=5a49f40d-2e54-46fb-8317-b0be12fd9f05,processId=workflowB,state=2]
+2024-05-14 12:09:10,336 INFO  [org.jbp.pro.cor.eve.EventTypeFilter] (kogito-event-executor-1) This event is subscribed to a message ref processInstanceCompleted:5a49f40d-2e54-46fb-8317-b0be12fd9f05 WorkflowProcessInstance [Id=5a49f40d-2e54-46fb-8317-b0be12fd9f05,processId=workflowB,state=2]
+2024-05-14 12:09:10,339 INFO  [org.kie.kog.ser.wor.dev.DevModeServerlessWorkflowLogger] (kogito-event-executor-1) Triggered node 'waitForEventsJoin' for process 'master' (0ee42b37-7106-4157-9d75-00842f1fea45)
+2024-05-14 12:09:10,339 INFO  [org.kie.kog.ser.wor.dev.DevModeServerlessWorkflowLogger] (kogito-event-executor-1) Triggered node 'End' for process 'master' (0ee42b37-7106-4157-9d75-00842f1fea45)
+2024-05-14 12:09:10,340 INFO  [org.kie.kog.ser.wor.dev.DevModeServerlessWorkflowLogger] (kogito-event-executor-1) Triggered node 'End' for process 'master' (0ee42b37-7106-4157-9d75-00842f1fea45)
+```
diff --git a/serverless-workflow-examples/serverless-workflow-subflows-event/pom.xml b/serverless-workflow-examples/serverless-workflow-subflows-event/pom.xml
@@ -0,0 +1,192 @@
+<?xml version="1.0"?>
+<!--
+
+    Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+-->
+<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"
+         xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+    <modelVersion>4.0.0</modelVersion>
+
+  <parent>
+    <groupId>org.kie.kogito.examples</groupId>
+    <artifactId>serverless-workflow-examples-parent</artifactId>
+    <version>999-SNAPSHOT</version>
+    <relativePath>../serverless-workflow-examples-parent/pom.xml</relativePath>
+  </parent>
+
+    <artifactId>serverless-workflow-subflows-event</artifactId>
+    <version>1.0-SNAPSHOT</version>
+
+    <name>Kogito Example :: Serverless Workflow Subflows Event :: Quarkus</name>
+    <description>Kogito Serverless Workflow Subflows Event - Quarkus</description>
+
+    <properties>
+        <quarkus-plugin.version>3.8.4</quarkus-plugin.version>
+        <quarkus.platform.artifact-id>quarkus-bom</quarkus.platform.artifact-id>
+        <quarkus.platform.group-id>io.quarkus</quarkus.platform.group-id>
+        <quarkus.platform.version>3.8.4</quarkus.platform.version>
+        <kogito.bom.group-id>org.kie.kogito</kogito.bom.group-id>
+        <kogito.bom.artifact-id>kogito-bom</kogito.bom.artifact-id>
+        <kogito.bom.version>999-SNAPSHOT</kogito.bom.version>
+        <version.org.kie.kogito>999-SNAPSHOT</version.org.kie.kogito>
+        <maven.compiler.release>17</maven.compiler.release>
+        <version.compiler.plugin>3.8.1</version.compiler.plugin>
+        <version.surefire.plugin>3.0.0-M7</version.surefire.plugin>
+        <version.failsafe.plugin>${version.surefire.plugin}</version.failsafe.plugin>
+    </properties>
+
+    <dependencyManagement>
+        <dependencies>
+            <dependency>
+                <groupId>${quarkus.platform.group-id}</groupId>
+                <artifactId>${quarkus.platform.artifact-id}</artifactId>
+                <version>${quarkus.platform.version}</version>
+                <type>pom</type>
+                <scope>import</scope>
+            </dependency>
+            <dependency>
+                <groupId>${kogito.bom.group-id}</groupId>
+                <artifactId>${kogito.bom.artifact-id}</artifactId>
+                <version>${kogito.bom.version}</version>
+                <type>pom</type>
+                <scope>import</scope>
+            </dependency>
+        </dependencies>
+    </dependencyManagement>
+    <dependencies>
+        <dependency>
+            <groupId>org.apache.kie.sonataflow</groupId>
+            <artifactId>sonataflow-quarkus</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-resteasy-jackson</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-arc</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-resteasy</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-smallrye-openapi</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-junit5</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>io.rest-assured</groupId>
+            <artifactId>rest-assured</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+          <groupId>org.awaitility</groupId>
+          <artifactId>awaitility</artifactId>
+          <scope>test</scope>
+        </dependency>
+    </dependencies>
+    <build>
+        <finalName>${project.artifactId}</finalName>
+        <plugins>
+            <plugin>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>${version.compiler.plugin}</version>
+                <configuration>
+                    <release>${maven.compiler.release}</release>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>${quarkus.platform.group-id}</groupId>
+                <artifactId>quarkus-maven-plugin</artifactId>
+                <version>${quarkus-plugin.version}</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>build</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>${version.surefire.plugin}</version>
+                <configuration>
+                    <systemPropertyVariables>
+                        <java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
+                        <maven.home>${maven.home}</maven.home>
+                    </systemPropertyVariables>
+                </configuration>
+            </plugin>
+            <plugin>
+                <artifactId>maven-failsafe-plugin</artifactId>
+                <version>${version.failsafe.plugin}</version>
+                <configuration>
+                    <systemPropertyVariables>
+                        <java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
+                        <maven.home>${maven.home}</maven.home>
+                    </systemPropertyVariables>
+                </configuration>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>integration-test</goal>
+                            <goal>verify</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+    <profiles>
+        <profile>
+            <id>container</id>
+            <activation>
+                <property>
+                    <name>container</name>
+                </property>
+            </activation>
+            <properties>
+                <quarkus.profile>container</quarkus.profile>
+            </properties>
+            <dependencies>
+                <dependency>
+                    <groupId>io.quarkus</groupId>
+                    <artifactId>quarkus-container-image-jib</artifactId>
+                </dependency>
+            </dependencies>
+        </profile>
+        <profile>
+            <id>native</id>
+            <activation>
+                <property>
+                    <name>native</name>
+                </property>
+            </activation>
+            <properties>
+                <quarkus.package.type>native</quarkus.package.type>
+            </properties>
+        </profile>
+    </profiles>
+</project>
diff --git a/...low-examples/serverless-workflow-subflows-event/src/main/resources/application.properties b/...low-examples/serverless-workflow-subflows-event/src/main/resources/application.properties
@@ -0,0 +1,32 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+mp.messaging.incoming.executeA.connector=quarkus-http
+mp.messaging.incoming.executeA.path=/executeA
+
+mp.messaging.incoming.executeB.connector=quarkus-http
+mp.messaging.incoming.executeB.path=/executeB
+
+# profile to pack this example into a container, to use it execute activate the maven container profile, -Dcontainer
+%container.quarkus.container-image.build=true
+%container.quarkus.container-image.push=false
+%container.quarkus.container-image.group=${USER}
+%container.quarkus.container-image.registry=dev.local
+%container.quarkus.container-image.tag=1.0-SNAPSHOT
+
+quarkus.devservices.enabled=false
diff --git a/...ss-workflow-examples/serverless-workflow-subflows-event/src/main/resources/master.sw.json b/...ss-workflow-examples/serverless-workflow-subflows-event/src/main/resources/master.sw.json
@@ -0,0 +1,66 @@
+{
+  "id": "master",
+  "version": "1.0",
+  "specVersion": "0.8",
+  "name": "master",
+  "start": "setup",
+  "events": [
+    {
+      "name": "executeA",
+      "source": "",
+      "type": "executeA"
+    },
+    {
+      "name": "executeB",
+      "source": "",
+      "type": "executeB"
+    }
+  ],
+  "states": [
+    {
+      "name": "setup",
+      "type" : "operation",
+      "actions": [{
+        "name": "setup",
+        "subFlowRef" : "setup"
+       }], 
+       "transition": "waitForEvents"  
+     }, 
+     {
+        "name": "waitForEvents",
+        "type": "event",
+         "onEvents": [
+         {
+          "eventRefs": [
+            "executeA"
+          ],
+          "actions": [ 
+          {
+            "name": "workflowA",
+            "subFlowRef": "workflowA",
+            "actionDataFilter" : {
+              "useResults": false
+            }
+          }
+          ]
+        },
+        { 
+         "eventRefs": [
+            "executeB"
+          ],
+          "actions": [ 
+          {
+            "name": "workflowB",
+            "subFlowRef": "workflowB",
+            "actionDataFilter" : {
+              "useResults": false
+            }
+          }
+          ]
+        }
+       ],
+       "exclusive": false,
+       "end" : true 
+     }
+  ]
+}