io.temporal.internal.common

Class WorkflowExecutionUtils

java.lang.Object

io.temporal.internal.common.WorkflowExecutionUtils

public class WorkflowExecutionUtils
extends java.lang.Object

Convenience methods to be used by unit tests and during development.

Constructor Summary

Constructors

Constructor and Description
WorkflowExecutionUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	containsEvent(java.util.List<io.temporal.api.history.v1.HistoryEvent> history, io.temporal.api.enums.v1.EventType eventType)
static io.temporal.api.workflow.v1.WorkflowExecutionInfo	describeWorkflowInstance(io.temporal.serviceclient.WorkflowServiceStubs service, java.lang.String namespace, io.temporal.api.common.v1.WorkflowExecution workflowExecution, com.uber.m3.tally.Scope metricsScope)
static io.temporal.api.enums.v1.WorkflowExecutionStatus	getCloseStatus(io.temporal.api.history.v1.HistoryEvent event)
static io.temporal.api.enums.v1.EventType	getEventTypeForCommand(io.temporal.api.enums.v1.CommandType commandType) Returns event that corresponds to a command.
static java.lang.String	getFailureCause(io.temporal.api.history.v1.HistoryEvent historyEvent)
static java.util.Iterator<io.temporal.api.history.v1.HistoryEvent>	getHistory(io.temporal.serviceclient.WorkflowServiceStubs service, java.lang.String namespace, io.temporal.api.common.v1.WorkflowExecution workflowExecution, com.uber.m3.tally.Scope metricsScope)
static io.temporal.api.workflowservice.v1.GetWorkflowExecutionHistoryResponse	getHistoryPage(io.temporal.serviceclient.WorkflowServiceStubs service, java.lang.String namespace, io.temporal.api.common.v1.WorkflowExecution workflowExecution, com.google.protobuf.ByteString nextPageToken, com.uber.m3.tally.Scope metricsScope)
static java.lang.String	getId(io.temporal.api.history.v1.HistoryEvent historyEvent)
static io.temporal.api.history.v1.HistoryEvent	getInstanceCloseEvent(io.temporal.serviceclient.WorkflowServiceStubs service, java.lang.String namespace, io.temporal.api.common.v1.WorkflowExecution workflowExecution, com.uber.m3.tally.Scope metricsScope, long timeout, java.util.concurrent.TimeUnit unit)
static java.util.Optional<io.temporal.api.common.v1.Payloads>	getWorkflowExecutionResult(io.temporal.serviceclient.WorkflowServiceStubs service, java.lang.String namespace, io.temporal.api.common.v1.WorkflowExecution workflowExecution, java.util.Optional<java.lang.String> workflowType, com.uber.m3.tally.Scope metricsScope, DataConverter converter, long timeout, java.util.concurrent.TimeUnit unit) Returns result of a workflow instance execution or throws an exception if workflow did not complete successfully.
static java.util.concurrent.CompletableFuture<java.util.Optional<io.temporal.api.common.v1.Payloads>>	getWorkflowExecutionResultAsync(io.temporal.serviceclient.WorkflowServiceStubs service, java.lang.String namespace, io.temporal.api.common.v1.WorkflowExecution workflowExecution, java.util.Optional<java.lang.String> workflowType, long timeout, java.util.concurrent.TimeUnit unit, DataConverter converter)
static io.temporal.api.common.v1.WorkflowExecution	getWorkflowIdFromExternalWorkflowCompletedEvent(io.temporal.api.history.v1.HistoryEvent event)
static boolean	isActivityTaskClosedEvent(io.temporal.api.history.v1.HistoryEvent event)
static boolean	isCommandEvent(io.temporal.api.history.v1.HistoryEvent event) Is this an event that was created to mirror a command?
static boolean	isExternalWorkflowClosedEvent(io.temporal.api.history.v1.HistoryEvent event)
static boolean	isFullHistory(io.temporal.api.workflowservice.v1.PollWorkflowTaskQueueResponseOrBuilder workflowTask)
static boolean	isWorkflowExecutionCompleteCommand(io.temporal.api.command.v1.Command command)
static boolean	isWorkflowExecutionCompletedEvent(io.temporal.api.history.v1.HistoryEventOrBuilder event)
static java.lang.String	prettyPrintCommands(java.lang.Iterable<io.temporal.api.command.v1.Command> commands)
static java.lang.String	prettyPrintHistory(io.temporal.api.history.v1.History history, boolean showWorkflowTasks) Returns workflow instance history in a human readable format.
static java.lang.String	prettyPrintHistory(java.util.Iterator<io.temporal.api.history.v1.HistoryEvent> events, boolean showWorkflowTasks)
static java.lang.String	prettyPrintHistory(io.temporal.serviceclient.WorkflowServiceStubs service, java.lang.String namespace, io.temporal.api.common.v1.WorkflowExecution workflowExecution, boolean showWorkflowTasks, com.uber.m3.tally.Scope metricsScope) Returns workflow instance history in a human readable format.
static java.lang.String	prettyPrintHistory(io.temporal.serviceclient.WorkflowServiceStubs service, java.lang.String namespace, io.temporal.api.common.v1.WorkflowExecution workflowExecution, com.uber.m3.tally.Scope metricsScope) Returns workflow instance history in a human readable format.
static java.lang.String	prettyPrintObject(com.google.protobuf.MessageOrBuilder object) Pretty prints a proto message.
static WorkflowExecutionHistory	readHistory(java.io.File historyFile)
static WorkflowExecutionHistory	readHistoryFromResource(java.lang.String resourceFileName)
static io.temporal.api.enums.v1.WorkflowExecutionStatus	waitForWorkflowInstanceCompletion(io.temporal.serviceclient.WorkflowServiceStubs service, java.lang.String namespace, io.temporal.api.common.v1.WorkflowExecution workflowExecution, com.uber.m3.tally.Scope metricsScope) Blocks until workflow instance completes.
static io.temporal.api.enums.v1.WorkflowExecutionStatus	waitForWorkflowInstanceCompletion(io.temporal.serviceclient.WorkflowServiceStubs service, java.lang.String namespace, io.temporal.api.common.v1.WorkflowExecution workflowExecution, com.uber.m3.tally.Scope metricsScope, long timeout, java.util.concurrent.TimeUnit unit) Waits up to specified timeout for workflow instance completion.
static io.temporal.api.enums.v1.WorkflowExecutionStatus	waitForWorkflowInstanceCompletionAcrossGenerations(io.temporal.serviceclient.WorkflowServiceStubs service, java.lang.String namespace, io.temporal.api.common.v1.WorkflowExecution workflowExecution, com.uber.m3.tally.Scope metricsScope) Like waitForWorkflowInstanceCompletion(WorkflowServiceStubs, String, WorkflowExecution, Scope, long, TimeUnit) , but with no timeout.*
static io.temporal.api.enums.v1.WorkflowExecutionStatus	waitForWorkflowInstanceCompletionAcrossGenerations(io.temporal.serviceclient.WorkflowServiceStubs service, java.lang.String namespace, io.temporal.api.common.v1.WorkflowExecution workflowExecution, com.uber.m3.tally.Scope metricsScope, long timeout, java.util.concurrent.TimeUnit unit) Like waitForWorkflowInstanceCompletion(WorkflowServiceStubs, String, WorkflowExecution, Scope, long, TimeUnit) , except will wait for continued generations of the original workflow execution too.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowExecutionUtils

public WorkflowExecutionUtils()

Method Detail

getWorkflowExecutionResult

public static java.util.Optional<io.temporal.api.common.v1.Payloads> getWorkflowExecutionResult(io.temporal.serviceclient.WorkflowServiceStubs service,
                                                                                                java.lang.String namespace,
                                                                                                io.temporal.api.common.v1.WorkflowExecution workflowExecution,
                                                                                                java.util.Optional<java.lang.String> workflowType,
                                                                                                com.uber.m3.tally.Scope metricsScope,
                                                                                                DataConverter converter,
                                                                                                long timeout,
                                                                                                java.util.concurrent.TimeUnit unit)
                                                                                         throws java.util.concurrent.TimeoutException

Returns result of a workflow instance execution or throws an exception if workflow did not complete successfully.

Parameters:

workflowType - is optional.

metricsScope - metrics with NAMESPACE tag populated

Throws:

java.util.concurrent.TimeoutException - if workflow didn't complete within specified timeout

CanceledFailure - if workflow was canceled

WorkflowExecutionFailedException - if workflow execution failed

getWorkflowExecutionResultAsync

public static java.util.concurrent.CompletableFuture<java.util.Optional<io.temporal.api.common.v1.Payloads>> getWorkflowExecutionResultAsync(io.temporal.serviceclient.WorkflowServiceStubs service,
                                                                                                                                             java.lang.String namespace,
                                                                                                                                             io.temporal.api.common.v1.WorkflowExecution workflowExecution,
                                                                                                                                             java.util.Optional<java.lang.String> workflowType,
                                                                                                                                             long timeout,
                                                                                                                                             java.util.concurrent.TimeUnit unit,
                                                                                                                                             DataConverter converter)

getInstanceCloseEvent

public static io.temporal.api.history.v1.HistoryEvent getInstanceCloseEvent(io.temporal.serviceclient.WorkflowServiceStubs service,
                                                                            java.lang.String namespace,
                                                                            io.temporal.api.common.v1.WorkflowExecution workflowExecution,
                                                                            com.uber.m3.tally.Scope metricsScope,
                                                                            long timeout,
                                                                            java.util.concurrent.TimeUnit unit)
                                                                     throws java.util.concurrent.TimeoutException

Parameters:

timeout - timeout to retrieve InstanceCloseEvent in unit units. If 0 - MAX_INTEGER will be used

unit - time unit of timeout

Returns:

an instance closing event, potentially waiting for workflow to complete.

Throws:

java.util.concurrent.TimeoutException

isWorkflowExecutionCompletedEvent

public static boolean isWorkflowExecutionCompletedEvent(io.temporal.api.history.v1.HistoryEventOrBuilder event)

isWorkflowExecutionCompleteCommand

public static boolean isWorkflowExecutionCompleteCommand(io.temporal.api.command.v1.Command command)

isActivityTaskClosedEvent

public static boolean isActivityTaskClosedEvent(io.temporal.api.history.v1.HistoryEvent event)

isExternalWorkflowClosedEvent

public static boolean isExternalWorkflowClosedEvent(io.temporal.api.history.v1.HistoryEvent event)

getWorkflowIdFromExternalWorkflowCompletedEvent

public static io.temporal.api.common.v1.WorkflowExecution getWorkflowIdFromExternalWorkflowCompletedEvent(io.temporal.api.history.v1.HistoryEvent event)

getId

public static java.lang.String getId(io.temporal.api.history.v1.HistoryEvent historyEvent)

getFailureCause

public static java.lang.String getFailureCause(io.temporal.api.history.v1.HistoryEvent historyEvent)

waitForWorkflowInstanceCompletion

public static io.temporal.api.enums.v1.WorkflowExecutionStatus waitForWorkflowInstanceCompletion(io.temporal.serviceclient.WorkflowServiceStubs service,
                                                                                                 java.lang.String namespace,
                                                                                                 io.temporal.api.common.v1.WorkflowExecution workflowExecution,
                                                                                                 com.uber.m3.tally.Scope metricsScope)

Blocks until workflow instance completes. Never use in production setting as polling for worklow instance status is an expensive operation.

Parameters:

workflowExecution - workflowId and optional runId

Returns:

instance close status

waitForWorkflowInstanceCompletion

public static io.temporal.api.enums.v1.WorkflowExecutionStatus waitForWorkflowInstanceCompletion(io.temporal.serviceclient.WorkflowServiceStubs service,
                                                                                                 java.lang.String namespace,
                                                                                                 io.temporal.api.common.v1.WorkflowExecution workflowExecution,
                                                                                                 com.uber.m3.tally.Scope metricsScope,
                                                                                                 long timeout,
                                                                                                 java.util.concurrent.TimeUnit unit)
                                                                                          throws java.util.concurrent.TimeoutException

Waits up to specified timeout for workflow instance completion. Never use in production setting as polling for worklow instance status is an expensive operation.

Parameters:

workflowExecution - workflowId and optional runId

metricsScope - to use when reporting service calls

timeout - maximum time to wait for completion. 0 means wait forever.

Returns:

instance close status

Throws:

java.util.concurrent.TimeoutException

getCloseStatus

public static io.temporal.api.enums.v1.WorkflowExecutionStatus getCloseStatus(io.temporal.api.history.v1.HistoryEvent event)

waitForWorkflowInstanceCompletionAcrossGenerations

public static io.temporal.api.enums.v1.WorkflowExecutionStatus waitForWorkflowInstanceCompletionAcrossGenerations(io.temporal.serviceclient.WorkflowServiceStubs service,
                                                                                                                  java.lang.String namespace,
                                                                                                                  io.temporal.api.common.v1.WorkflowExecution workflowExecution,
                                                                                                                  com.uber.m3.tally.Scope metricsScope,
                                                                                                                  long timeout,
                                                                                                                  java.util.concurrent.TimeUnit unit)
                                                                                                           throws java.util.concurrent.TimeoutException

Like waitForWorkflowInstanceCompletion(WorkflowServiceStubs, String, WorkflowExecution, Scope, long, TimeUnit) , except will wait for continued generations of the original workflow execution too.

Throws:

java.util.concurrent.TimeoutException

See Also:

waitForWorkflowInstanceCompletion(WorkflowServiceStubs, String, WorkflowExecution, Scope, long, TimeUnit)

waitForWorkflowInstanceCompletionAcrossGenerations

public static io.temporal.api.enums.v1.WorkflowExecutionStatus waitForWorkflowInstanceCompletionAcrossGenerations(io.temporal.serviceclient.WorkflowServiceStubs service,
                                                                                                                  java.lang.String namespace,
                                                                                                                  io.temporal.api.common.v1.WorkflowExecution workflowExecution,
                                                                                                                  com.uber.m3.tally.Scope metricsScope)
                                                                                                           throws java.lang.InterruptedException

Like waitForWorkflowInstanceCompletion(WorkflowServiceStubs, String, WorkflowExecution, Scope, long, TimeUnit) , but with no timeout.*

Throws:

java.lang.InterruptedException

describeWorkflowInstance

public static io.temporal.api.workflow.v1.WorkflowExecutionInfo describeWorkflowInstance(io.temporal.serviceclient.WorkflowServiceStubs service,
                                                                                         java.lang.String namespace,
                                                                                         io.temporal.api.common.v1.WorkflowExecution workflowExecution,
                                                                                         com.uber.m3.tally.Scope metricsScope)

getHistoryPage

public static io.temporal.api.workflowservice.v1.GetWorkflowExecutionHistoryResponse getHistoryPage(io.temporal.serviceclient.WorkflowServiceStubs service,
                                                                                                    java.lang.String namespace,
                                                                                                    io.temporal.api.common.v1.WorkflowExecution workflowExecution,
                                                                                                    com.google.protobuf.ByteString nextPageToken,
                                                                                                    com.uber.m3.tally.Scope metricsScope)

prettyPrintHistory

public static java.lang.String prettyPrintHistory(io.temporal.serviceclient.WorkflowServiceStubs service,
                                                  java.lang.String namespace,
                                                  io.temporal.api.common.v1.WorkflowExecution workflowExecution,
                                                  com.uber.m3.tally.Scope metricsScope)

Returns workflow instance history in a human readable format.

prettyPrintHistory

public static java.lang.String prettyPrintHistory(io.temporal.serviceclient.WorkflowServiceStubs service,
                                                  java.lang.String namespace,
                                                  io.temporal.api.common.v1.WorkflowExecution workflowExecution,
                                                  boolean showWorkflowTasks,
                                                  com.uber.m3.tally.Scope metricsScope)

Returns workflow instance history in a human readable format.

Parameters:

showWorkflowTasks - when set to false workflow task events (command events) are not included

metricsScope -

getHistory

public static java.util.Iterator<io.temporal.api.history.v1.HistoryEvent> getHistory(io.temporal.serviceclient.WorkflowServiceStubs service,
                                                                                     java.lang.String namespace,
                                                                                     io.temporal.api.common.v1.WorkflowExecution workflowExecution,
                                                                                     com.uber.m3.tally.Scope metricsScope)

prettyPrintHistory

public static java.lang.String prettyPrintHistory(io.temporal.api.history.v1.History history,
                                                  boolean showWorkflowTasks)

Returns workflow instance history in a human readable format.

Parameters:

showWorkflowTasks - when set to false workflow task events (command events) are not included

history - Workflow instance history

prettyPrintHistory

public static java.lang.String prettyPrintHistory(java.util.Iterator<io.temporal.api.history.v1.HistoryEvent> events,
                                                  boolean showWorkflowTasks)

prettyPrintCommands

public static java.lang.String prettyPrintCommands(java.lang.Iterable<io.temporal.api.command.v1.Command> commands)

prettyPrintObject

public static java.lang.String prettyPrintObject(com.google.protobuf.MessageOrBuilder object)

Pretty prints a proto message.

containsEvent

public static boolean containsEvent(java.util.List<io.temporal.api.history.v1.HistoryEvent> history,
                                    io.temporal.api.enums.v1.EventType eventType)

isCommandEvent

public static boolean isCommandEvent(io.temporal.api.history.v1.HistoryEvent event)

Is this an event that was created to mirror a command?

getEventTypeForCommand

public static io.temporal.api.enums.v1.EventType getEventTypeForCommand(io.temporal.api.enums.v1.CommandType commandType)

Returns event that corresponds to a command.

readHistoryFromResource

public static WorkflowExecutionHistory readHistoryFromResource(java.lang.String resourceFileName)
                                                        throws java.io.IOException

Throws:

java.io.IOException

readHistory

public static WorkflowExecutionHistory readHistory(java.io.File historyFile)
                                            throws java.io.IOException

Throws:

java.io.IOException

isFullHistory

public static boolean isFullHistory(io.temporal.api.workflowservice.v1.PollWorkflowTaskQueueResponseOrBuilder workflowTask)