Refactor StateOptions and execute failure policy (#74)

integ/execute_api_fail_recovery_workflow_state1.go

@@ -7,26 +7,26 @@ import (
 	"github.com/indeedeng/iwf-golang-sdk/iwf"
 )
 
-type executeApiFailRecoveryWorkflowState1 struct{}
+type executeApiFailRecoveryWorkflowState1 struct {
+	iwf.WorkflowStateDefaultsNoWaitUntil
+}
 
 func (b executeApiFailRecoveryWorkflowState1) GetStateId() string {
 	return "execute_api_fail_recovery_workflow_state1"
 }
 
-func (b executeApiFailRecoveryWorkflowState1) GetStateOptions() *iwfidl.WorkflowStateOptions {
-	options := iwf.NewWorkflowStateOptionsExtension(nil).SetProceedOnExecuteFailure(executeApiFailRecoveryWorkflowState2{}, nil)
-	options.ExecuteApiRetryPolicy = &iwfidl.RetryPolicy{
-		InitialIntervalSeconds: iwfidl.PtrInt32(1),
-		MaximumAttempts:        iwfidl.PtrInt32(1),
+func (b executeApiFailRecoveryWorkflowState1) GetStateOptions() *iwf.StateOptions {
+	options := &iwf.StateOptions{
+		ExecuteApiRetryPolicy: &iwfidl.RetryPolicy{
+			InitialIntervalSeconds: iwfidl.PtrInt32(1),
+			MaximumAttempts:        iwfidl.PtrInt32(1),
+		},
+		ExecuteApiFailureProceedState: &executeApiFailRecoveryWorkflowState2{},
 	}
 
 	return options
 }
 
-func (b executeApiFailRecoveryWorkflowState1) WaitUntil(ctx iwf.WorkflowContext, input iwf.Object, persistence iwf.Persistence, communication iwf.Communication) (*iwf.CommandRequest, error) {
-	return iwf.EmptyCommandRequest(), nil
-}
-
 func (b executeApiFailRecoveryWorkflowState1) Execute(ctx iwf.WorkflowContext, input iwf.Object, commandResults iwf.CommandResults, persistence iwf.Persistence, communication iwf.Communication) (*iwf.StateDecision, error) {
 	return nil, errors.New("error")
 }

integ/execute_api_fail_recovery_workflow_state2.go

@@ -5,15 +5,7 @@ import (
 )
 
 type executeApiFailRecoveryWorkflowState2 struct {
-	iwf.DefaultStateOptions
-}
-
-func (b executeApiFailRecoveryWorkflowState2) GetStateId() string {
-	return "execute_api_fail_recovery_workflow_state2"
-}
-
-func (b executeApiFailRecoveryWorkflowState2) WaitUntil(ctx iwf.WorkflowContext, input iwf.Object, persistence iwf.Persistence, communication iwf.Communication) (*iwf.CommandRequest, error) {
-	return iwf.EmptyCommandRequest(), nil
+	iwf.WorkflowStateDefaultsNoWaitUntil
 }
 
 func (b executeApiFailRecoveryWorkflowState2) Execute(ctx iwf.WorkflowContext, input iwf.Object, commandResults iwf.CommandResults, persistence iwf.Persistence, communication iwf.Communication) (*iwf.StateDecision, error) {

integ/proceed_on_state_start_fail_workflow_state1.go

@@ -27,8 +27,8 @@ func (b *proceedOnStateStartFailWorkflowState1) Execute(ctx iwf.WorkflowContext,
 	return iwf.SingleNextState(&proceedOnStateStartFailWorkflowState2{}, b.output), nil
 }
 
-func (b *proceedOnStateStartFailWorkflowState1) GetStateOptions() *iwfidl.WorkflowStateOptions {
-	return &iwfidl.WorkflowStateOptions{
+func (b *proceedOnStateStartFailWorkflowState1) GetStateOptions() *iwf.StateOptions {
+	return &iwf.StateOptions{
 		WaitUntilApiRetryPolicy: &iwfidl.RetryPolicy{
 			InitialIntervalSeconds: iwfidl.PtrInt32(1),
 			MaximumAttempts:        iwfidl.PtrInt32(2),

integ/state_api_fail_workflow_state1.go

@@ -18,8 +18,8 @@ func (b stateApiFailWorkflowState1) Execute(ctx iwf.WorkflowContext, input iwf.O
 	return iwf.ForceFailWorkflow("a failing message"), nil
 }
 
-func (b stateApiFailWorkflowState1) GetStateOptions() *iwfidl.WorkflowStateOptions {
-	return &iwfidl.WorkflowStateOptions{
+func (b stateApiFailWorkflowState1) GetStateOptions() *iwf.StateOptions {
+	return &iwf.StateOptions{
 		WaitUntilApiRetryPolicy: &iwfidl.RetryPolicy{
 			MaximumAttempts: iwfidl.PtrInt32(1),
 		},

integ/state_api_timeout_workflow_state1.go

@@ -19,8 +19,8 @@ func (b stateApiTimeoutWorkflowState1) Execute(ctx iwf.WorkflowContext, input iw
 	return iwf.ForceFailWorkflow("a failing message"), nil
 }
 
-func (b stateApiTimeoutWorkflowState1) GetStateOptions() *iwfidl.WorkflowStateOptions {
-	return &iwfidl.WorkflowStateOptions{
+func (b stateApiTimeoutWorkflowState1) GetStateOptions() *iwf.StateOptions {
+	return &iwf.StateOptions{
 		WaitUntilApiRetryPolicy: &iwfidl.RetryPolicy{
 			MaximumAttempts: iwfidl.PtrInt32(1),
 		},

iwf/client_impl.go

@@ -30,16 +30,7 @@ func (c *clientImpl) StartWorkflow(ctx context.Context, workflow ObjectWorkflow,
 	if state != nil {
 		startStateId = GetFinalWorkflowStateId(state)
 		startStateOpt := state.GetStateOptions()
-		if ShouldSkipWaitUntilAPI(state) {
-			if startStateOpt == nil {
-				startStateOpt = &iwfidl.WorkflowStateOptions{
-					SkipWaitUntil: ptr.Any(true),
-				}
-			} else {
-				startStateOpt.SkipWaitUntil = ptr.Any(true)
-			}
-		}
-		unregOpt.StartStateOptions = startStateOpt
+		unregOpt.StartStateOptions = toIdlStateOptions(ShouldSkipWaitUntilAPI(state), startStateOpt)
 	}
 
 	if options != nil {

iwf/internal_mapper.go

@@ -103,16 +103,7 @@ func toIdlDecision(from *StateDecision, wfType string, registry Registry, encode
 		var options *iwfidl.WorkflowStateOptions
 		if !strings.HasPrefix(fromMv.NextStateId, ReservedStateIdPrefix) {
 			stateDef := registry.getWorkflowStateDef(wfType, fromMv.NextStateId)
-			options = stateDef.State.GetStateOptions()
-			if ShouldSkipWaitUntilAPI(stateDef.State) {
-				if options == nil {
-					options = &iwfidl.WorkflowStateOptions{
-						SkipWaitUntil: ptr.Any(true),
-					}
-				} else {
-					options.SkipWaitUntil = ptr.Any(true)
-				}
-			}
+			options = toIdlStateOptions(ShouldSkipWaitUntilAPI(stateDef.State), stateDef.State.GetStateOptions())
 		}
 		mv := iwfidl.StateMovement{
 			StateId:      fromMv.NextStateId,
@@ -125,3 +116,37 @@ func toIdlDecision(from *StateDecision, wfType string, registry Registry, encode
 		NextStates: mvs,
 	}, nil
 }
+
+func toIdlStateOptions(skipWaitUntil bool, stateOptions *StateOptions) *iwfidl.WorkflowStateOptions {
+	if stateOptions == nil {
+		stateOptions = &StateOptions{}
+	}
+
+	idlStOptions := &iwfidl.WorkflowStateOptions{
+		SearchAttributesLoadingPolicy: stateOptions.SearchAttributesLoadingPolicy,
+		DataAttributesLoadingPolicy:   stateOptions.DataAttributesLoadingPolicy,
+		WaitUntilApiTimeoutSeconds:    stateOptions.WaitUntilApiTimeoutSeconds,
+		ExecuteApiTimeoutSeconds:      stateOptions.ExecuteApiTimeoutSeconds,
+		WaitUntilApiRetryPolicy:       stateOptions.WaitUntilApiRetryPolicy,
+		ExecuteApiRetryPolicy:         stateOptions.ExecuteApiRetryPolicy,
+		WaitUntilApiFailurePolicy:     stateOptions.WaitUntilApiFailurePolicy,
+	}
+
+	if skipWaitUntil {
+		idlStOptions.SkipWaitUntil = ptr.Any(true)
+	}
+
+	if stateOptions.ExecuteApiFailureProceedState != nil {
+		idlStOptions.ExecuteApiFailurePolicy = iwfidl.PROCEED_TO_CONFIGURED_STATE.Ptr()
+		idlStOptions.ExecuteApiFailureProceedStateId = ptr.Any(GetFinalWorkflowStateId(stateOptions.ExecuteApiFailureProceedState))
+
+		proceedStateOptions := stateOptions.ExecuteApiFailureProceedState.GetStateOptions()
+		if proceedStateOptions != nil && proceedStateOptions.ExecuteApiFailureProceedState != nil {
+			panic("nested failure handling/recovery is not supported: ExecuteApiFailureProceedState cannot have ExecuteApiFailureProceedState")
+		}
+		idlStOptions.ExecuteApiFailureProceedStateOptions =
+			toIdlStateOptions(ShouldSkipWaitUntilAPI(stateOptions.ExecuteApiFailureProceedState), proceedStateOptions)
+	}
+
+	return idlStOptions
+}

iwf/state_options.go

@@ -0,0 +1,16 @@
+package iwf
+
+import (
+	"github.com/indeedeng/iwf-golang-sdk/gen/iwfidl"
+)
+
+type StateOptions struct {
+	SearchAttributesLoadingPolicy *iwfidl.PersistenceLoadingPolicy
+	DataAttributesLoadingPolicy   *iwfidl.PersistenceLoadingPolicy
+	WaitUntilApiTimeoutSeconds    *int32
+	ExecuteApiTimeoutSeconds      *int32
+	WaitUntilApiRetryPolicy       *iwfidl.RetryPolicy
+	ExecuteApiRetryPolicy         *iwfidl.RetryPolicy
+	WaitUntilApiFailurePolicy     *iwfidl.WaitUntilApiFailurePolicy
+	ExecuteApiFailureProceedState WorkflowState
+}

iwf/workflow_state.go

@@ -1,7 +1,6 @@
 package iwf
 
 import (
-	"github.com/indeedeng/iwf-golang-sdk/gen/iwfidl"
 	"reflect"
 )
 
@@ -51,7 +50,7 @@ type WorkflowState interface {
 
 	// GetStateOptions can just return nil to use the default Options
 	// StateOptions is optional configuration to adjust the state behaviors
-	GetStateOptions() *iwfidl.WorkflowStateOptions
+	GetStateOptions() *StateOptions
 }
 
 // GetFinalWorkflowStateId returns the stateId that will be registered and used
@@ -95,7 +94,7 @@ func (d DefaultStateId) GetStateId() string {
 
 type DefaultStateOptions struct{}
 
-func (d DefaultStateOptions) GetStateOptions() *iwfidl.WorkflowStateOptions {
+func (d DefaultStateOptions) GetStateOptions() *StateOptions {
 	return nil
 }