Initial Workflow SDK

examples/components/workflows/redis.yaml

@@ -0,0 +1,14 @@
+apiVersion: dapr.io/v1alpha1
+kind: Component
+metadata:
+  name: statestore
+spec:
+  type: state.redis
+  version: v1
+  metadata:
+  - name: redisHost
+    value: localhost:6379
+  - name: redisPassword
+    value: ""
+  - name: actorStateStore
+    value: "true"

examples/pom.xml

@@ -118,6 +118,16 @@
       <artifactId>dapr-sdk-actors</artifactId>
       <version>${project.version}</version>
     </dependency>
+    <dependency>
+      <groupId>io.dapr</groupId>
+      <artifactId>dapr-sdk-workflows</artifactId>
+      <version>0.1.0-alpha-SNAPSHOT</version>
+    </dependency>
+    <dependency>
+      <groupId>com.microsoft</groupId>
+      <artifactId>durabletask-client</artifactId>
+      <version>1.1.0</version>
+    </dependency>
     <dependency>
       <groupId>io.dapr</groupId>
       <artifactId>dapr-sdk</artifactId>

examples/src/main/java/io/dapr/examples/workflows/DemoWorkflow.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2023 The Dapr Authors
+ * Licensed 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.
+*/
+
+package io.dapr.examples.workflows;
+
+import com.microsoft.durabletask.TaskCanceledException;
+import io.dapr.workflows.runtime.Workflow;
+import io.dapr.workflows.runtime.WorkflowContext;
+
+import java.time.Duration;
+import java.util.concurrent.TimeoutException;
+
+/**
+ * Implementation of the DemoWorkflow for the server side.
+ */
+public class DemoWorkflow extends Workflow {
+
+  @Override
+  public void run(WorkflowContext ctx) {
+    ctx.getLogger().info("Starting Workflow: " + ctx.getName());
+    ctx.getLogger().info("Instance ID: " + ctx.getInstanceId());
+    ctx.getLogger().info("Waiting for event: 'myEvent'...");
+    try {
+      ctx.waitForExternalEvent("myEvent", Duration.ofSeconds(10)).await();
+      ctx.getLogger().info("Received!");
+    } catch (TaskCanceledException e) {
+      ctx.getLogger().warn("Timed out");
+      ctx.getLogger().warn(e.getMessage());
+    }
+    ctx.complete("finished");
+  }
+}

examples/src/main/java/io/dapr/examples/workflows/DemoWorkflowClient.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2023 The Dapr Authors
+ * Licensed 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.
+*/
+
+package io.dapr.examples.workflows;
+
+import io.dapr.workflows.client.DaprWorkflowClient;
+
+import java.util.concurrent.TimeUnit;
+
+/**
+ * For setup instructions, see the README.
+ */
+public class DemoWorkflowClient {
+
+  /**
+   * The main method.
+   * @param args Input arguments (unused).
+   * @throws InterruptedException If program has been interrupted.
+   */
+  public static void main(String[] args) throws InterruptedException {
+    DaprWorkflowClient client = new DaprWorkflowClient();
+
+    try (client) {
+      System.out.println("*****");
+      String instanceId = client.scheduleNewWorkflow(DemoWorkflow.class);
+      System.out.printf("Started new workflow instance with random ID: %s%n", instanceId);
+
+      System.out.println("Sleep and allow this workflow instance to timeout...");
+      TimeUnit.SECONDS.sleep(10);
+
+      System.out.println("*****");
+      String instanceToTerminateId = "terminateMe";
+      client.scheduleNewWorkflow(DemoWorkflow.class, null, instanceToTerminateId);
+      System.out.printf("Started new workflow instance with specified ID: %s%n", instanceToTerminateId);
+
+      TimeUnit.SECONDS.sleep(5);
+      System.out.println("Terminate this workflow instance manually before the timeout is reached");
+      client.terminateWorkflow(instanceToTerminateId, null);
+      System.out.println("*****");
+    }
+
+    System.out.println("Exiting DemoWorkflowClient.");
+    System.exit(0);
+  }
+}

examples/src/main/java/io/dapr/examples/workflows/DemoWorkflowWorker.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2023 The Dapr Authors
+ * Licensed 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.
+*/
+
+package io.dapr.examples.workflows;
+
+import io.dapr.workflows.runtime.WorkflowRuntime;
+
+/**
+ * For setup instructions, see the README.
+ */
+public class DemoWorkflowWorker {
+
+  /**
+   * The main method of this app.
+   *
+   * @param args The port the app will listen on.
+   * @throws Exception An Exception.
+   */
+  public static void main(String[] args) throws Exception {
+    // Register the Workflow with the runtime.
+    WorkflowRuntime.getInstance().registerWorkflow(DemoWorkflow.class);
+    System.out.println("Start workflow runtime");
+    WorkflowRuntime.getInstance().startAndBlock();
+    System.exit(0);
+  }
+}

examples/src/main/java/io/dapr/examples/workflows/README.md

@@ -0,0 +1,78 @@
+# Dapr Workflow Sample
+
+In this example, we'll use Dapr to test workflow features.
+
+Visit [the Workflow documentation landing page](https://docs.dapr.io/developing-applications/building-blocks/workflow) for more information.
+
+This example contains the follow classes:
+
+* DemoWorkflow: An example of a Dapr Workflow.
+* DemoWorkflowClient: This application will start workflows using Dapr.
+* DemoWorkflowWorker: An application that registers a workflow to the Dapr workflow runtime engine. It also executes the workflow instance.
+
+## Pre-requisites
+
+* [Dapr and Dapr Cli](https://docs.dapr.io/getting-started/install-dapr/).
+  * Run `dapr init`.
+* Java JDK 11 (or greater):
+    * [Microsoft JDK 11](https://docs.microsoft.com/en-us/java/openjdk/download#openjdk-11)
+    * [Oracle JDK 11](https://www.oracle.com/technetwork/java/javase/downloads/index.html#JDK11)
+    * [OpenJDK 11](https://jdk.java.net/11/)
+* [Apache Maven](https://maven.apache.org/install.html) version 3.x.
+
+### Checking out the code
+
+Clone this repository:
+
+```sh
+git clone https://github.com/dapr/java-sdk.git
+cd java-sdk
+```
+
+Then build the Maven project:
+
+```sh
+# make sure you are in the `java-sdk` directory.
+mvn install
+```
+
+Get into the `examples` directory.
+```sh
+cd examples
+```
+
+### Running the demo Workflow worker
+
+The first Java class to consider is `DemoWorkflowWorker`. Its job is to register an implementation of `DemoWorkflow` in the Dapr's workflow runtime engine. In `DemoWorkflowWorker.java` file, you will find the `DemoWorkflowWorker` class and the `main` method. See the code snippet below:
+
+```java
+public class DemoWorkflowWorker {
+
+  public static void main(String[] args) throws Exception {
+    // Register the Workflow with the runtime.
+    WorkflowRuntime.getInstance().registerWorkflow(DemoWorkflow.class);
+    System.out.println("Start workflow runtime");
+    WorkflowRuntime.getInstance().startAndBlock();
+    System.exit(0);
+  }
+}
+```
+
+This application uses `WorkflowRuntime.getInstance().registerWorkflow()` in order to register `DemoWorkflow` as a Workflow in the Dapr Workflow runtime.
+
+`WorkflowRuntime.getInstance().start()` method will build and start the engine within the Dapr workflow runtime.
+
+Now, execute the following script in order to run DemoWorkflowWorker:
+```sh
+dapr run --app-id demoworkflowworker --resources-path ./components/workflows --dapr-grpc-port 50001 -- java -jar target/dapr-java-sdk-examples-exec.jar io.dapr.examples.workflows.DemoWorkflowWorker
+```
+
+### Running the Workflow client
+
+The `DemoWorkflowClient` starts instances of workflows that have been registered with Dapr.
+
+With the DemoWorkflowWorker running, use the follow command to start the workflow with the DemoWorkflowClient:
+
+```sh
+java -jar target/dapr-java-sdk-examples-exec.jar io.dapr.examples.workflows.DemoWorkflowClient
+```

pom.xml

@@ -7,7 +7,27 @@
   <groupId>io.dapr</groupId>
   <artifactId>dapr-sdk-parent</artifactId>
   <packaging>pom</packaging>
-  <version>1.9.0-SNAPSHOT</version>
+    <dependencies>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+        </dependency>
+      <dependency>
+        <groupId>junit</groupId>
+        <artifactId>junit</artifactId>
+      </dependency>
+      <dependency>
+        <groupId>junit</groupId>
+        <artifactId>junit</artifactId>
+      </dependency>
+      <dependency>
+          <groupId>com.microsoft</groupId>
+          <artifactId>durabletask-client</artifactId>
+          <version>1.1.0</version>
+          <scope>compile</scope>
+      </dependency>
+    </dependencies>
+    <version>1.9.0-SNAPSHOT</version>
   <name>dapr-sdk-parent</name>
   <description>SDK for Dapr.</description>
   <url>https://dapr.io</url>
@@ -88,7 +108,7 @@
       <plugin>
         <groupId>org.jacoco</groupId>
         <artifactId>jacoco-maven-plugin</artifactId>
-        <version>0.8.6</version>
+        <version>0.8.8</version>
         <executions>
           <execution>
             <goals>
@@ -301,6 +321,7 @@
     <module>sdk-autogen</module>
     <module>sdk</module>
     <module>sdk-actors</module>
+    <module>sdk-workflows</module>
     <module>sdk-springboot</module>
     <module>examples</module>
   </modules>