Add workflow already completed error to client (#1081)

Author: demirkayaender

client/client.go

@@ -134,6 +134,7 @@ type (
 		// The errors it can return:
 		//	- EntityNotExistsError
 		//	- InternalServiceError
+		//	- WorkflowExecutionAlreadyCompletedError
 		SignalWorkflow(ctx context.Context, workflowID string, runID string, signalName string, arg interface{}) error
 
 		// SignalWithStartWorkflow sends a signal to a running workflow.
@@ -154,6 +155,7 @@ type (
 		//	- EntityNotExistsError
 		//	- BadRequestError
 		//	- InternalServiceError
+		//	- WorkflowExecutionAlreadyCompletedError
 		CancelWorkflow(ctx context.Context, workflowID string, runID string) error
 
 		// TerminateWorkflow terminates a workflow execution.
@@ -164,6 +166,7 @@ type (
 		//	- EntityNotExistsError
 		//	- BadRequestError
 		//	- InternalServiceError
+		//	- WorkflowExecutionAlreadyCompletedError
 		TerminateWorkflow(ctx context.Context, workflowID string, runID string, reason string, details []byte) error
 
 		// GetWorkflowHistory gets history events of a particular workflow

internal/client.go

@@ -114,6 +114,7 @@ type (
 		// The errors it can return:
 		//	- EntityNotExistsError
 		//	- InternalServiceError
+		//	- WorkflowExecutionAlreadyCompletedError
 		SignalWorkflow(ctx context.Context, workflowID string, runID string, signalName string, arg interface{}) error
 
 		// SignalWithStartWorkflow sends a signal to a running workflow.
@@ -136,6 +137,7 @@ type (
 		//	- EntityNotExistsError
 		//	- BadRequestError
 		//	- InternalServiceError
+		//	- WorkflowExecutionAlreadyCompletedError
 		CancelWorkflow(ctx context.Context, workflowID string, runID string) error
 
 		// TerminateWorkflow terminates a workflow execution.
@@ -146,6 +148,7 @@ type (
 		//	- EntityNotExistsError
 		//	- BadRequestError
 		//	- InternalServiceError
+		//	- WorkflowExecutionAlreadyCompletedError
 		TerminateWorkflow(ctx context.Context, workflowID string, runID string, reason string, details []byte) error
 
 		// GetWorkflowHistory gets history events of a particular workflow

internal/common/metrics/service_wrapper.go

@@ -121,6 +121,7 @@ func (s *operationScope) handleError(err error) {
 			*shared.BadRequestError,
 			*shared.DomainAlreadyExistsError,
 			*shared.WorkflowExecutionAlreadyStartedError,
+			*shared.WorkflowExecutionAlreadyCompletedError,
 			*shared.QueryFailedError:
 			s.scope.Counter(CadenceInvalidRequest).Inc(1)
 		default:

internal/internal_retry.go

@@ -67,6 +67,7 @@ func isServiceTransientError(err error) bool {
 	case *s.BadRequestError,
 		*s.EntityNotExistsError,
 		*s.WorkflowExecutionAlreadyStartedError,
+		*s.WorkflowExecutionAlreadyCompletedError,
 		*s.DomainAlreadyExistsError,
 		*s.QueryFailedError,
 		*s.DomainNotActiveError,

internal/internal_workflow_testsuite.go

@@ -2027,7 +2027,7 @@ func (env *testWorkflowEnvironmentImpl) signalWorkflowByID(workflowID, signalNam
 
 	if workflowHandle, ok := env.runningWorkflows[workflowID]; ok {
 		if workflowHandle.handled {
-			return &shared.EntityNotExistsError{Message: fmt.Sprintf("Workflow %v already completed", workflowID)}
+			return &shared.WorkflowExecutionAlreadyCompletedError{Message: fmt.Sprintf("Workflow %v already completed", workflowID)}
 		}
 		workflowHandle.env.postCallback(func() {
 			workflowHandle.env.signalHandler(signalName, data)