Added updatabletimer sample (#15)

Author: mfateev

src/main/java/io/temporal/samples/updatabletimer/DynamicSleepWorkflow.java

@@ -0,0 +1,37 @@
+/*
+ *  Copyright (c) 2020 Temporal Technologies, Inc. All Rights Reserved
+ *
+ *  Copyright 2012-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ *  Modifications copyright (C) 2017 Uber Technologies, Inc.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License"). You may not
+ *  use this file except in compliance with the License. A copy of the License is
+ *  located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ *  or in the "license" file accompanying this file. This file 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.temporal.samples.updatabletimer;
+
+import io.temporal.workflow.QueryMethod;
+import io.temporal.workflow.SignalMethod;
+import io.temporal.workflow.WorkflowInterface;
+import io.temporal.workflow.WorkflowMethod;
+
+@WorkflowInterface
+public interface DynamicSleepWorkflow {
+  @WorkflowMethod
+  void execute(long wakeUpTime);
+
+  @SignalMethod
+  void updateWakeUpTime(long wakeUpTime);
+
+  @QueryMethod
+  long getWakeUpTime();
+}

src/main/java/io/temporal/samples/updatabletimer/DynamicSleepWorkflowImpl.java

@@ -0,0 +1,40 @@
+/*
+ *  Copyright (c) 2020 Temporal Technologies, Inc. All Rights Reserved
+ *
+ *  Copyright 2012-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ *  Modifications copyright (C) 2017 Uber Technologies, Inc.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License"). You may not
+ *  use this file except in compliance with the License. A copy of the License is
+ *  located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ *  or in the "license" file accompanying this file. This file 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.temporal.samples.updatabletimer;
+
+public class DynamicSleepWorkflowImpl implements DynamicSleepWorkflow {
+
+  private UpdatableTimer timer = new UpdatableTimer();
+
+  @Override
+  public void execute(long wakeUpTime) {
+    timer.sleepUntil(wakeUpTime);
+  }
+
+  @Override
+  public void updateWakeUpTime(long wakeUpTime) {
+    timer.updateWakeUpTime(wakeUpTime);
+  }
+
+  @Override
+  public long getWakeUpTime() {
+    return timer.getWakeUpTime();
+  }
+}

src/main/java/io/temporal/samples/updatabletimer/DynamicSleepWorkflowStarter.java

@@ -0,0 +1,60 @@
+/*
+ *  Copyright (c) 2020 Temporal Technologies, Inc. All Rights Reserved
+ *
+ *  Copyright 2012-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ *  Modifications copyright (C) 2017 Uber Technologies, Inc.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License"). You may not
+ *  use this file except in compliance with the License. A copy of the License is
+ *  located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ *  or in the "license" file accompanying this file. This file 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.temporal.samples.updatabletimer;
+
+import static io.temporal.samples.updatabletimer.DynamicSleepWorkflowWorker.DYNAMIC_SLEEP_WORKFLOW_ID;
+import static io.temporal.samples.updatabletimer.DynamicSleepWorkflowWorker.TASK_LIST;
+
+import io.temporal.client.DuplicateWorkflowException;
+import io.temporal.client.WorkflowClient;
+import io.temporal.client.WorkflowOptions;
+import io.temporal.proto.common.WorkflowExecution;
+import io.temporal.proto.common.WorkflowIdReusePolicy;
+import io.temporal.serviceclient.WorkflowServiceStubs;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class DynamicSleepWorkflowStarter {
+
+  private static final Logger logger = LoggerFactory.getLogger(DynamicSleepWorkflowStarter.class);
+
+  public static void main(String[] args) {
+    WorkflowServiceStubs service = WorkflowServiceStubs.newInstance();
+    WorkflowClient client = WorkflowClient.newInstance(service);
+
+    DynamicSleepWorkflow workflow =
+        client.newWorkflowStub(
+            DynamicSleepWorkflow.class,
+            WorkflowOptions.newBuilder()
+                .setTaskList(TASK_LIST)
+                .setWorkflowId(DYNAMIC_SLEEP_WORKFLOW_ID)
+                .setWorkflowIdReusePolicy(WorkflowIdReusePolicy.AllowDuplicate)
+                .build());
+
+    try {
+      // Start asynchronously
+      WorkflowExecution execution =
+          WorkflowClient.start(workflow::execute, System.currentTimeMillis() + 60000);
+      logger.info("Workflow started: " + execution);
+    } catch (DuplicateWorkflowException e) {
+      logger.info("Workflow already running: " + e.getExecution());
+    }
+  }
+}

src/main/java/io/temporal/samples/updatabletimer/DynamicSleepWorkflowWorker.java

@@ -0,0 +1,46 @@
+/*
+ *  Copyright (c) 2020 Temporal Technologies, Inc. All Rights Reserved
+ *
+ *  Copyright 2012-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ *  Modifications copyright (C) 2017 Uber Technologies, Inc.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License"). You may not
+ *  use this file except in compliance with the License. A copy of the License is
+ *  located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ *  or in the "license" file accompanying this file. This file 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.temporal.samples.updatabletimer;
+
+import io.temporal.client.WorkflowClient;
+import io.temporal.serviceclient.WorkflowServiceStubs;
+import io.temporal.worker.Worker;
+import io.temporal.worker.WorkerFactory;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class DynamicSleepWorkflowWorker {
+
+  static final String TASK_LIST = "TimerUpdate";
+
+  private static final Logger logger = LoggerFactory.getLogger(DynamicSleepWorkflowWorker.class);
+  /** Create just one workflow instance for the sake of the sample. */
+  static final String DYNAMIC_SLEEP_WORKFLOW_ID = "DynamicSleepWorkflow";
+
+  public static void main(String[] args) {
+    WorkflowServiceStubs service = WorkflowServiceStubs.newInstance();
+    WorkflowClient client = WorkflowClient.newInstance(service);
+    WorkerFactory factory = WorkerFactory.newInstance(client);
+    final Worker worker = factory.newWorker(TASK_LIST);
+    worker.registerWorkflowImplementationTypes(DynamicSleepWorkflowImpl.class);
+    factory.start();
+    logger.info("Worker started for task list: " + TASK_LIST);
+  }
+}

src/main/java/io/temporal/samples/updatabletimer/README.md

@@ -0,0 +1,40 @@
+# Updatable Timer Sample
+
+Demonstrates a helper class which relies on Workflow.await to implement a blocking sleep that can be updated
+at any moment.
+
+The sample is composed of the three executables: 
+
+* `DynamicSleepWorkflowWorker` hosts the workflow code
+* `DynamicSleepWorkflowStarter` starts a workflow instance.
+* `WakeUpTimeUpdater` signals the workflow instance with the new time to wake up
+
+### 
+
+First start the worker:
+
+    ./gradlew -q execute -PmainClass=io.temporal.samples.updatabletimer.DynamicSleepWorkflowWorker
+    
+Then in a different terminal window start the workflow instance:
+
+    ./gradlew -q execute -PmainClass=io.temporal.samples.updatabletimer.DynamicSleepWorkflowStarter
+    
+Check the output of the worker window. The expected output is:
+
+```bash
+10:38:56.282 [main] INFO  i.t.s.timerupdate.DynamicSleepWorker - Worker started for task list: TimerUpdate
+10:39:07.359 [workflow-732875527] INFO  i.t.s.t.DynamicSleepWorkflowImpl - sleepUntil: Thu May 28 10:40:06 PDT 2020
+10:39:07.360 [workflow-732875527] INFO  i.t.s.t.DynamicSleepWorkflowImpl - Going to sleep for PT59.688S
+```
+Then run the updater as many times as you want to change timer to 10 seconds from now:
+
+    ./gradlew -q execute -PmainClass=io.temporal.samples.updatabletimer.WakeUpTimeUpdater
+    ./gradlew -q execute -PmainClass=io.temporal.samples.updatabletimer.WakeUpTimeUpdater
+
+Check the output of the worker window. The expected output is:
+
+```bash
+10:39:12.934 [workflow-732875527] INFO  i.t.s.t.DynamicSleepWorkflowImpl - Going to sleep for PT9.721S
+10:39:20.755 [workflow-732875527] INFO  i.t.s.t.DynamicSleepWorkflowImpl - Going to sleep for PT9.733S
+10:39:30.772 [workflow-732875527] INFO  i.t.s.t.DynamicSleepWorkflowImpl - sleepUntil completed
+```

src/main/java/io/temporal/samples/updatabletimer/UpdatableTimer.java

@@ -0,0 +1,56 @@
+/*
+ *  Copyright (c) 2020 Temporal Technologies, Inc. All Rights Reserved
+ *
+ *  Copyright 2012-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ *  Modifications copyright (C) 2017 Uber Technologies, Inc.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License"). You may not
+ *  use this file except in compliance with the License. A copy of the License is
+ *  located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ *  or in the "license" file accompanying this file. This file 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.temporal.samples.updatabletimer;
+
+import io.temporal.workflow.Workflow;
+import java.time.Duration;
+import java.util.Date;
+import org.slf4j.Logger;
+
+public final class UpdatableTimer {
+
+  private final Logger logger = Workflow.getLogger(DynamicSleepWorkflowImpl.class);
+
+  private long wakeUpTime;
+  private boolean wakeUpTimeUpdated;
+
+  public void sleepUntil(long wakeUpTime) {
+    logger.info("sleepUntil: " + new Date(wakeUpTime));
+    this.wakeUpTime = wakeUpTime;
+    do {
+      wakeUpTimeUpdated = false;
+      Duration sleepInterval = Duration.ofMillis(this.wakeUpTime - Workflow.currentTimeMillis());
+      logger.info("Going to sleep for " + sleepInterval);
+      if (!Workflow.await(sleepInterval, () -> wakeUpTimeUpdated)) {
+        break;
+      }
+    } while (wakeUpTimeUpdated);
+    logger.info("sleepUntil completed");
+  }
+
+  public void updateWakeUpTime(long wakeUpTime) {
+    this.wakeUpTime = wakeUpTime;
+    this.wakeUpTimeUpdated = true;
+  }
+
+  public long getWakeUpTime() {
+    return wakeUpTime;
+  }
+}

src/main/java/io/temporal/samples/updatabletimer/WakeUpTimeUpdater.java

@@ -0,0 +1,45 @@
+/*
+ *  Copyright (c) 2020 Temporal Technologies, Inc. All Rights Reserved
+ *
+ *  Copyright 2012-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ *  Modifications copyright (C) 2017 Uber Technologies, Inc.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License"). You may not
+ *  use this file except in compliance with the License. A copy of the License is
+ *  located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ *  or in the "license" file accompanying this file. This file 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.temporal.samples.updatabletimer;
+
+import static io.temporal.samples.updatabletimer.DynamicSleepWorkflowWorker.DYNAMIC_SLEEP_WORKFLOW_ID;
+
+import io.temporal.client.WorkflowClient;
+import io.temporal.serviceclient.WorkflowServiceStubs;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class WakeUpTimeUpdater {
+
+  private static final Logger logger = LoggerFactory.getLogger(WakeUpTimeUpdater.class);
+
+  public static void main(String[] args) {
+    WorkflowServiceStubs service = WorkflowServiceStubs.newInstance();
+    WorkflowClient client = WorkflowClient.newInstance(service);
+
+    // Create a stub that points to an existing workflow with the given ID
+    DynamicSleepWorkflow workflow =
+        client.newWorkflowStub(DynamicSleepWorkflow.class, DYNAMIC_SLEEP_WORKFLOW_ID);
+
+    // signal workflow about the wake up time change
+    workflow.updateWakeUpTime(System.currentTimeMillis() + 10000);
+    logger.info("Updated wake up time to 10 seconds from now");
+  }
+}

src/main/resources/logback.xml

@@ -26,7 +26,7 @@
         </encoder>
     </appender>
     <logger name="io.grpc.netty" level="INFO"/>
-    <root level="WARN">
+    <root level="INFO">
         <appender-ref ref="STDOUT" />
     </root>
 </configuration>