Replace WorkflowIDReusePolicy and ParentClosePolicy enums with proto …

…ones (#173)

client/client.go

@@ -71,18 +71,12 @@ type (
 	// WorkflowRun represents a started non child workflow.
 	WorkflowRun = internal.WorkflowRun
 
-	// WorkflowIDReusePolicy defines workflow ID reuse behavior.
-	WorkflowIDReusePolicy = internal.WorkflowIDReusePolicy
-
 	// QueryWorkflowWithOptionsRequest defines the request to QueryWorkflowWithOptions.
 	QueryWorkflowWithOptionsRequest = internal.QueryWorkflowWithOptionsRequest
 
 	// QueryWorkflowWithOptionsResponse defines the response to QueryWorkflowWithOptions.
 	QueryWorkflowWithOptionsResponse = internal.QueryWorkflowWithOptionsResponse
 
-	// ParentClosePolicy defines the behavior performed on a child workflow when its parent is closed.
-	ParentClosePolicy = internal.ParentClosePolicy
-
 	// Client is the client for starting and getting information about a workflow executions as well as
 	// completing activities asynchronously.
 	Client interface {
@@ -143,8 +137,7 @@ type (
 		// If the workflow is not running or not found, it starts the workflow and then sends the signal in transaction.
 		// - workflowID, signalName, signalArg are same as SignalWorkflow's parameters
 		// - options, workflow, workflowArgs are same as StartWorkflow's parameters
-		// Note: options.WorkflowIDReusePolicy is default to WorkflowIDReusePolicyAllowDuplicate in this API;
-		// while in StartWorkflow/ExecuteWorkflow APIs it is default to WorkflowIdReusePolicyAllowDuplicateFailedOnly.
+		// Note: options.WorkflowIDReusePolicy is default to AllowDuplicate in this API.
 		// The errors it can return:
 		//  - EntityNotExistsError, if namespace does not exist
 		//  - BadRequestError
@@ -386,29 +379,6 @@ type (
 	}
 )
 
-const (
-	// WorkflowIDReusePolicyAllowDuplicateFailedOnly allow start a workflow execution
-	// when workflow not running, and the last execution close state is in
-	// [terminated, cancelled, timeout, failed].
-	WorkflowIDReusePolicyAllowDuplicateFailedOnly WorkflowIDReusePolicy = internal.WorkflowIDReusePolicyAllowDuplicateFailedOnly
-
-	// WorkflowIDReusePolicyAllowDuplicate allow start a workflow execution using
-	// the same workflow ID,when workflow not running.
-	WorkflowIDReusePolicyAllowDuplicate WorkflowIDReusePolicy = internal.WorkflowIDReusePolicyAllowDuplicate
-
-	// WorkflowIDReusePolicyRejectDuplicate do not allow start a workflow execution using the same workflow ID at all
-	WorkflowIDReusePolicyRejectDuplicate WorkflowIDReusePolicy = internal.WorkflowIDReusePolicyRejectDuplicate
-)
-
-const (
-	// ParentClosePolicyTerminate means terminating the child workflow
-	ParentClosePolicyTerminate = internal.ParentClosePolicyTerminate
-	// ParentClosePolicyRequestCancel means requesting cancellation on the child workflow
-	ParentClosePolicyRequestCancel = internal.ParentClosePolicyRequestCancel
-	// ParentClosePolicyAbandon means not doing anything on the child workflow
-	ParentClosePolicyAbandon = internal.ParentClosePolicyAbandon
-)
-
 // NewClient creates an instance of a workflow client
 func NewClient(options Options) (Client, error) {
 	return internal.NewClient(options)

internal/client.go

@@ -26,7 +26,6 @@ package internal
 
 import (
 	"context"
-	"fmt"
 	"io"
 	"time"
 
@@ -115,8 +114,7 @@ type (
 		// If the workflow is not running or not found, it starts the workflow and then sends the signal in transaction.
 		// - workflowID, signalName, signalArg are same as SignalWorkflow's parameters
 		// - options, workflow, workflowArgs are same as StartWorkflow's parameters
-		// Note: options.WorkflowIDReusePolicy is default to WorkflowIDReusePolicyAllowDuplicate in this API;
-		// while in StartWorkflow/ExecuteWorkflow APIs it is default to WorkflowIdReusePolicyAllowDuplicateFailedOnly.
+		// Note: options.WorkflowIDReusePolicy is default to AllowDuplicate.
 		// The errors it can return:
 		//  - EntityNotExistsError, if namespace does not exist
 		//  - BadRequestError
@@ -418,9 +416,9 @@ type (
 		WorkflowTaskTimeout time.Duration
 
 		// WorkflowIDReusePolicy - Whether server allow reuse of workflow ID, can be useful
-		// for dedup logic if set to WorkflowIdReusePolicyRejectDuplicate.
-		// Optional: defaulted to WorkflowIDReusePolicyAllowDuplicateFailedOnly.
-		WorkflowIDReusePolicy WorkflowIDReusePolicy
+		// for dedup logic if set to RejectDuplicate.
+		// Optional: defaulted to AllowDuplicate.
+		WorkflowIDReusePolicy enumspb.WorkflowIdReusePolicy
 
 		// RetryPolicy - Optional retry policy for workflow. If a retry policy is specified, in case of workflow failure
 		// server will start new workflow execution if needed based on the retry policy.
@@ -513,35 +511,6 @@ type (
 		// Close client and clean up underlying resources.
 		Close()
 	}
-
-	// WorkflowIDReusePolicy defines workflow ID reuse behavior.
-	WorkflowIDReusePolicy int
-
-	// ParentClosePolicy defines the action on children when parent is closed
-	ParentClosePolicy int
-)
-
-const (
-	// ParentClosePolicyTerminate means terminating the child workflow
-	ParentClosePolicyTerminate ParentClosePolicy = iota
-	// ParentClosePolicyRequestCancel means requesting cancellation on the child workflow
-	ParentClosePolicyRequestCancel
-	// ParentClosePolicyAbandon means not doing anything on the child workflow
-	ParentClosePolicyAbandon
-)
-
-const (
-	// WorkflowIDReusePolicyAllowDuplicate allow start a workflow execution using
-	// the same workflow ID, when workflow not running.
-	WorkflowIDReusePolicyAllowDuplicate WorkflowIDReusePolicy = iota
-
-	// WorkflowIDReusePolicyAllowDuplicateFailedOnly allow start a workflow execution
-	// when workflow not running, and the last execution close state is in
-	// [terminated, cancelled, timed out, failed].
-	WorkflowIDReusePolicyAllowDuplicateFailedOnly
-
-	// WorkflowIDReusePolicyRejectDuplicate do not allow start a workflow execution using the same workflow ID at all.
-	WorkflowIDReusePolicyRejectDuplicate
 )
 
 // NewClient creates an instance of a workflow client
@@ -639,32 +608,6 @@ func newNamespaceServiceClient(workflowServiceClient workflowservice.WorkflowSer
 	}
 }
 
-func (p WorkflowIDReusePolicy) toProto() enumspb.WorkflowIdReusePolicy {
-	switch p {
-	case WorkflowIDReusePolicyAllowDuplicate:
-		return enumspb.WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE
-	case WorkflowIDReusePolicyAllowDuplicateFailedOnly:
-		return enumspb.WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY
-	case WorkflowIDReusePolicyRejectDuplicate:
-		return enumspb.WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE
-	default:
-		panic(fmt.Sprintf("unknown workflow reuse policy %v", p))
-	}
-}
-
-func (p ParentClosePolicy) toProto() enumspb.ParentClosePolicy {
-	switch p {
-	case ParentClosePolicyAbandon:
-		return enumspb.PARENT_CLOSE_POLICY_ABANDON
-	case ParentClosePolicyRequestCancel:
-		return enumspb.PARENT_CLOSE_POLICY_REQUEST_CANCEL
-	case ParentClosePolicyTerminate:
-		return enumspb.PARENT_CLOSE_POLICY_TERMINATE
-	default:
-		panic(fmt.Sprintf("unknown workflow parent close policy %v", p))
-	}
-}
-
 // NewValue creates a new encoded.Value which can be used to decode binary data returned by Temporal.  For example:
 // User had Activity.RecordHeartbeat(ctx, "my-heartbeat") and then got response from calling Client.DescribeWorkflowExecution.
 // The response contains binary field PendingActivityInfo.HeartbeatDetails,

internal/internal_event_handlers.go

@@ -385,8 +385,8 @@ func (wc *workflowEnvironmentImpl) ExecuteChildWorkflow(
 	attributes.WorkflowTaskTimeoutSeconds = params.WorkflowTaskTimeoutSeconds
 	attributes.Input = params.Input
 	attributes.WorkflowType = &commonpb.WorkflowType{Name: params.WorkflowType.Name}
-	attributes.WorkflowIdReusePolicy = params.WorkflowIDReusePolicy.toProto()
-	attributes.ParentClosePolicy = params.ParentClosePolicy.toProto()
+	attributes.WorkflowIdReusePolicy = params.WorkflowIDReusePolicy
+	attributes.ParentClosePolicy = params.ParentClosePolicy
 	attributes.RetryPolicy = params.RetryPolicy
 	attributes.Header = params.Header
 	attributes.Memo = memo

internal/internal_workflow.go

@@ -36,11 +36,11 @@ import (
 	"time"
 	"unicode"
 
+	commonpb "go.temporal.io/temporal-proto/common/v1"
+	enumspb "go.temporal.io/temporal-proto/enums/v1"
 	"go.uber.org/atomic"
 	"go.uber.org/zap"
 
-	commonpb "go.temporal.io/temporal-proto/common/v1"
-
 	"go.temporal.io/temporal/internal/common/metrics"
 )
 
@@ -182,14 +182,14 @@ type (
 		Namespace                       string
 		WorkflowID                      string
 		WaitForCancellation             bool
-		WorkflowIDReusePolicy           WorkflowIDReusePolicy
+		WorkflowIDReusePolicy           enumspb.WorkflowIdReusePolicy
 		DataConverter                   DataConverter
 		RetryPolicy                     *commonpb.RetryPolicy
 		CronSchedule                    string
 		ContextPropagators              []ContextPropagator
 		Memo                            map[string]interface{}
 		SearchAttributes                map[string]interface{}
-		ParentClosePolicy               ParentClosePolicy
+		ParentClosePolicy               enumspb.ParentClosePolicy
 		signalChannels                  map[string]Channel
 		queryHandlers                   map[string]func(*commonpb.Payloads) (*commonpb.Payloads, error)
 	}

internal/internal_workflow_client.go

@@ -213,7 +213,7 @@ func (wc *WorkflowClient) StartWorkflow(
 		WorkflowRunTimeoutSeconds:       runTimeout,
 		WorkflowTaskTimeoutSeconds:      workflowTaskTimeout,
 		Identity:                        wc.identity,
-		WorkflowIdReusePolicy:           options.WorkflowIDReusePolicy.toProto(),
+		WorkflowIdReusePolicy:           options.WorkflowIDReusePolicy,
 		RetryPolicy:                     convertRetryPolicy(options.RetryPolicy),
 		CronSchedule:                    options.CronSchedule,
 		Memo:                            memo,
@@ -397,7 +397,7 @@ func (wc *WorkflowClient) SignalWithStartWorkflow(ctx context.Context, workflowI
 		CronSchedule:                    options.CronSchedule,
 		Memo:                            memo,
 		SearchAttributes:                searchAttr,
-		WorkflowIdReusePolicy:           options.WorkflowIDReusePolicy.toProto(),
+		WorkflowIdReusePolicy:           options.WorkflowIDReusePolicy,
 		Header:                          header,
 	}
 

internal/internal_workflow_client_test.go

@@ -54,7 +54,7 @@ const (
 	taskqueue             = "some random taskqueue"
 	identity              = "some random identity"
 	timeoutInSeconds      = 20
-	workflowIDReusePolicy = WorkflowIDReusePolicyAllowDuplicateFailedOnly
+	workflowIDReusePolicy = enumspb.WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY
 	testHeader            = "test-header"
 )
 

internal/internal_workflow_testsuite.go

@@ -363,10 +363,10 @@ func (env *testWorkflowEnvironmentImpl) newTestWorkflowEnvironmentForChild(param
 		if !workflowHandler.handled {
 			return nil, serviceerror.NewWorkflowExecutionAlreadyStarted("Workflow execution already started", "", "")
 		}
-		if params.WorkflowIDReusePolicy == WorkflowIDReusePolicyRejectDuplicate {
+		if params.WorkflowIDReusePolicy == enumspb.WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE {
 			return nil, serviceerror.NewWorkflowExecutionAlreadyStarted("Workflow execution already started", "", "")
 		}
-		if workflowHandler.err == nil && params.WorkflowIDReusePolicy == WorkflowIDReusePolicyAllowDuplicateFailedOnly {
+		if workflowHandler.err == nil && params.WorkflowIDReusePolicy == enumspb.WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY {
 			return nil, serviceerror.NewWorkflowExecutionAlreadyStarted("Workflow execution already started", "", "")
 		}
 	}

internal/internal_workflow_testsuite_test.go

@@ -2076,7 +2076,7 @@ func (s *WorkflowTestSuiteUnitTest) Test_WorkflowIDReusePolicy() {
 		cwo := ChildWorkflowOptions{
 			WorkflowRunTimeout:    time.Minute,
 			WorkflowID:            "test-child-workflow-id",
-			WorkflowIDReusePolicy: WorkflowIDReusePolicyRejectDuplicate,
+			WorkflowIDReusePolicy: enumspb.WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE,
 		}
 		ctx = WithChildWorkflowOptions(ctx, cwo)
 		var helloWorkflowResult string
@@ -2094,7 +2094,7 @@ func (s *WorkflowTestSuiteUnitTest) Test_WorkflowIDReusePolicy() {
 		s.Error(err)
 
 		// now with policy allow duplicate
-		cwo.WorkflowIDReusePolicy = WorkflowIDReusePolicyAllowDuplicate
+		cwo.WorkflowIDReusePolicy = enumspb.WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE
 		ctx = WithChildWorkflowOptions(ctx, cwo)
 		f = ExecuteChildWorkflow(ctx, testWorkflowHello)
 		err = f.GetChildWorkflowExecution().Get(ctx, nil)
@@ -2693,7 +2693,7 @@ func (s *WorkflowTestSuiteUnitTest) Test_ChildWorkflowAlreadyRunning() {
 		ctx1 := WithChildWorkflowOptions(ctx, ChildWorkflowOptions{
 			WorkflowID:            "Test_ChildWorkflowAlreadyRunning",
 			WorkflowRunTimeout:    time.Minute,
-			WorkflowIDReusePolicy: WorkflowIDReusePolicyAllowDuplicateFailedOnly,
+			WorkflowIDReusePolicy: enumspb.WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY,
 		})
 
 		var result1, result2 string

internal/workflow.go

@@ -33,6 +33,7 @@ import (
 
 	"github.com/uber-go/tally"
 	commonpb "go.temporal.io/temporal-proto/common/v1"
+	enumspb "go.temporal.io/temporal-proto/enums/v1"
 	"go.uber.org/zap"
 
 	"go.temporal.io/temporal/internal/common"
@@ -204,7 +205,7 @@ type (
 
 		// WorkflowIDReusePolicy - Whether server allow reuse of workflow ID, can be useful
 		// for dedup logic if set to WorkflowIdReusePolicyRejectDuplicate
-		WorkflowIDReusePolicy WorkflowIDReusePolicy
+		WorkflowIDReusePolicy enumspb.WorkflowIdReusePolicy
 
 		// RetryPolicy specify how to retry child workflow if error happens.
 		// Optional: default is no retry
@@ -237,7 +238,7 @@ type (
 
 		// ParentClosePolicy - Optional policy to decide what to do for the child.
 		// Default is Terminate (if onboarded to this feature)
-		ParentClosePolicy ParentClosePolicy
+		ParentClosePolicy enumspb.ParentClosePolicy
 	}
 )
 

test/bindings_test.go

@@ -142,7 +142,7 @@ func (ts *AsyncBindingsTestSuite) startWorkflowOptions(wfID string) client.Start
 		TaskQueue:                ts.taskQueueName,
 		WorkflowExecutionTimeout: 15 * time.Second,
 		WorkflowTaskTimeout:      time.Second,
-		WorkflowIDReusePolicy:    client.WorkflowIDReusePolicyAllowDuplicate,
+		WorkflowIDReusePolicy:    enumspb.WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE,
 	}
 }
 

test/integration_test.go

@@ -278,7 +278,7 @@ func (ts *IntegrationTestSuite) TestWorkflowIDReuseRejectDuplicate() {
 		ts.workflows.IDReusePolicy,
 		&result,
 		uuid.New(),
-		client.WorkflowIDReusePolicyRejectDuplicate,
+		enumspb.WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE,
 		false,
 		false,
 	)
@@ -297,7 +297,7 @@ func (ts *IntegrationTestSuite) TestWorkflowIDReuseAllowDuplicateFailedOnly1() {
 		ts.workflows.IDReusePolicy,
 		&result,
 		uuid.New(),
-		client.WorkflowIDReusePolicyAllowDuplicateFailedOnly,
+		enumspb.WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY,
 		false,
 		false,
 	)
@@ -316,7 +316,7 @@ func (ts *IntegrationTestSuite) TestWorkflowIDReuseAllowDuplicateFailedOnly2() {
 		ts.workflows.IDReusePolicy,
 		&result,
 		uuid.New(),
-		client.WorkflowIDReusePolicyAllowDuplicateFailedOnly,
+		enumspb.WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY,
 		false,
 		true,
 	)
@@ -331,7 +331,7 @@ func (ts *IntegrationTestSuite) TestWorkflowIDReuseAllowDuplicate() {
 		ts.workflows.IDReusePolicy,
 		&result,
 		uuid.New(),
-		client.WorkflowIDReusePolicyAllowDuplicate,
+		enumspb.WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE,
 		false,
 		false,
 	)
@@ -539,7 +539,7 @@ func (ts *IntegrationTestSuite) startWorkflowOptions(wfID string) client.StartWo
 		TaskQueue:                ts.taskQueueName,
 		WorkflowExecutionTimeout: 15 * time.Second,
 		WorkflowTaskTimeout:      time.Second,
-		WorkflowIDReusePolicy:    client.WorkflowIDReusePolicyAllowDuplicate,
+		WorkflowIDReusePolicy:    enumspb.WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE,
 	}
 }
 

test/workflow_test.go

@@ -33,7 +33,6 @@ import (
 	enumspb "go.temporal.io/temporal-proto/enums/v1"
 
 	"go.temporal.io/temporal"
-	"go.temporal.io/temporal/client"
 	"go.temporal.io/temporal/encoded"
 	"go.temporal.io/temporal/internal"
 	"go.temporal.io/temporal/worker"
@@ -225,7 +224,7 @@ func (w *Workflows) ContinueAsNewWithOptions(ctx workflow.Context, count int, ta
 func (w *Workflows) IDReusePolicy(
 	ctx workflow.Context,
 	childWFID string,
-	policy client.WorkflowIDReusePolicy,
+	policy enumspb.WorkflowIdReusePolicy,
 	parallel bool,
 	failFirstChild bool) (string, error) {
 
@@ -325,7 +324,7 @@ func (w *Workflows) ChildWorkflowSuccessWithParentClosePolicyAbandon(ctx workflo
 	opts := workflow.ChildWorkflowOptions{
 		WorkflowTaskTimeout:      5 * time.Second,
 		WorkflowExecutionTimeout: 10 * time.Second,
-		ParentClosePolicy:        client.ParentClosePolicyAbandon,
+		ParentClosePolicy:        enumspb.PARENT_CLOSE_POLICY_ABANDON,
 	}
 	ctx = workflow.WithChildOptions(ctx, opts)
 	ft := workflow.ExecuteChildWorkflow(ctx, w.sleep, 5*time.Second)