change functional Option pattern to internal.GetVersionOptions

Author: arzonus

internal/interceptors.go

@@ -63,7 +63,7 @@ type WorkflowInterceptor interface {
 	GetSignalChannel(ctx Context, signalName string) Channel
 	SideEffect(ctx Context, f func(ctx Context) interface{}) Value
 	MutableSideEffect(ctx Context, id string, f func(ctx Context) interface{}, equals func(a, b interface{}) bool) Value
-	GetVersion(ctx Context, changeID string, minSupported, maxSupported Version, opts ...GetVersionOption) Version
+	GetVersion(ctx Context, changeID string, minSupported, maxSupported Version, opts ...GetVersionOptions) Version
 	SetQueryHandler(ctx Context, queryType string, handler interface{}) error
 	IsReplaying(ctx Context) bool
 	HasLastCompletionResult(ctx Context) bool
@@ -158,7 +158,7 @@ func (t *WorkflowInterceptorBase) MutableSideEffect(ctx Context, id string, f fu
 }
 
 // GetVersion forwards to t.Next
-func (t *WorkflowInterceptorBase) GetVersion(ctx Context, changeID string, minSupported, maxSupported Version, opts ...GetVersionOption) Version {
+func (t *WorkflowInterceptorBase) GetVersion(ctx Context, changeID string, minSupported, maxSupported Version, opts ...GetVersionOptions) Version {
 	return t.Next.GetVersion(ctx, changeID, minSupported, maxSupported, opts...)
 }
 

internal/internal_event_handlers.go

@@ -602,7 +602,7 @@ func validateVersion(changeID string, version, minSupported, maxSupported Versio
 	}
 }
 
-func (wc *workflowEnvironmentImpl) GetVersion(changeID string, minSupported, maxSupported Version, opts ...GetVersionOption) Version {
+func (wc *workflowEnvironmentImpl) GetVersion(changeID string, minSupported, maxSupported Version, opts ...GetVersionOptions) Version {
 	// Check if the changeID already has a version assigned
 	// If it does, validate the version against the min and max supported versions
 	// ensuring it is within the acceptable range
@@ -611,10 +611,10 @@ func (wc *workflowEnvironmentImpl) GetVersion(changeID string, minSupported, max
 		return version
 	}
 
-	// Apply options to determine which version to use
-	options := &GetVersionOptions{}
-	for _, opt := range opts {
-		opt(options)
+	// Use the first option if they're present
+	var options GetVersionOptions
+	if len(opts) > 0 {
+		options = opts[0]
 	}
 
 	var version Version

internal/internal_worker_base.go

@@ -76,7 +76,7 @@ type (
 		localActivityClient
 		workflowTimerClient
 		SideEffect(f func() ([]byte, error), callback resultHandler)
-		GetVersion(changeID string, minSupported, maxSupported Version, opts ...GetVersionOption) Version
+		GetVersion(changeID string, minSupported, maxSupported Version, opts ...GetVersionOptions) Version
 		WorkflowInfo() *WorkflowInfo
 		Complete(result []byte, err error)
 		RegisterCancelHandler(handler func())

internal/internal_workflow_testsuite.go

@@ -1928,7 +1928,7 @@ func (env *testWorkflowEnvironmentImpl) SideEffect(f func() ([]byte, error), cal
 	callback(f())
 }
 
-func (env *testWorkflowEnvironmentImpl) GetVersion(changeID string, minSupported, maxSupported Version, opts ...GetVersionOption) (retVersion Version) {
+func (env *testWorkflowEnvironmentImpl) GetVersion(changeID string, minSupported, maxSupported Version, opts ...GetVersionOptions) (retVersion Version) {
 	if mockVersion, ok := env.getMockedVersion(changeID, changeID, minSupported, maxSupported); ok {
 		// GetVersion for changeID is mocked
 		env.UpsertSearchAttributes(createSearchAttributesForChangeVersion(changeID, mockVersion, env.changeVersions))

internal/workflow.go

@@ -1567,9 +1567,6 @@ const DefaultVersion Version = -1
 // CadenceChangeVersion is used as search attributes key to find workflows with specific change version.
 const CadenceChangeVersion = "CadenceChangeVersion"
 
-// GetVersionOption configures GetVersion behavior
-type GetVersionOption func(*GetVersionOptions)
-
 // GetVersionOptions contains options for GetVersion
 type GetVersionOptions struct {
 	// CustomVersion is used to force GetVersion to return a specific version
@@ -1581,7 +1578,7 @@ type GetVersionOptions struct {
 	UseMinVersion bool
 }
 
-// ExecuteWithVersion returns a GetVersionOption that forces a specific version to be returned
+// ExecuteWithVersion returns a GetVersionOptions that forces a specific version to be returned
 // when executed for the first time, instead of returning maxSupported version.
 //
 // This option can be used when you want to separate the versioning of the workflow code and
@@ -1637,18 +1634,18 @@ type GetVersionOptions struct {
 //
 // ExecuteWithVersion option is useful when you want to ensure that your changes can be safely rolled back if needed, as
 // both versions of the workflow code are compatible with each other.
-func ExecuteWithVersion(version Version) GetVersionOption {
-	return func(o *GetVersionOptions) {
-		o.CustomVersion = &version
+func ExecuteWithVersion(version Version) GetVersionOptions {
+	return GetVersionOptions{
+		CustomVersion: &version,
 	}
 }
 
-// ExecuteWithMinVersion returns a GetVersionOption that makes GetVersion return minSupported version
+// ExecuteWithMinVersion returns a GetVersionOptions that makes GetVersion return minSupported version
 // when executed for the first time, instead of returning maxSupported version.
 // To see how this option can be used, see the ExecuteWithVersion option
-func ExecuteWithMinVersion() GetVersionOption {
-	return func(o *GetVersionOptions) {
-		o.UseMinVersion = true
+func ExecuteWithMinVersion() GetVersionOptions {
+	return GetVersionOptions{
+		UseMinVersion: true,
 	}
 }
 
@@ -1718,12 +1715,12 @@ func ExecuteWithMinVersion() GetVersionOption {
 //	} else {
 //	  err = workflow.ExecuteActivity(ctx, qux, data).Get(ctx, nil)
 //	}
-func GetVersion(ctx Context, changeID string, minSupported, maxSupported Version, opts ...GetVersionOption) Version {
+func GetVersion(ctx Context, changeID string, minSupported, maxSupported Version, opts ...GetVersionOptions) Version {
 	i := getWorkflowInterceptor(ctx)
 	return i.GetVersion(ctx, changeID, minSupported, maxSupported, opts...)
 }
 
-func (wc *workflowEnvironmentInterceptor) GetVersion(ctx Context, changeID string, minSupported, maxSupported Version, opts ...GetVersionOption) Version {
+func (wc *workflowEnvironmentInterceptor) GetVersion(ctx Context, changeID string, minSupported, maxSupported Version, opts ...GetVersionOptions) Version {
 	return wc.env.GetVersion(changeID, minSupported, maxSupported, opts...)
 }
 

workflow/workflow.go

@@ -45,9 +45,6 @@ type (
 	// Version represents a change version. See GetVersion call.
 	Version = internal.Version
 
-	// GetVersionOption configures GetVersion behaviour
-	GetVersionOption = internal.GetVersionOption
-
 	// ChildWorkflowOptions stores all child workflow specific parameters that will be stored inside of a Context.
 	ChildWorkflowOptions = internal.ChildWorkflowOptions
 
@@ -356,7 +353,7 @@ func MutableSideEffect(ctx Context, id string, f func(ctx Context) interface{},
 // DefaultVersion is a version returned by GetVersion for code that wasn't versioned before
 const DefaultVersion Version = internal.DefaultVersion
 
-// ExecuteWithVersion returns a GetVersionOption that forces a specific version to be returned
+// ExecuteWithVersion returns a GetVersionOptions that forces a specific version to be returned
 // when executed for the first time, instead of returning maxSupported version.
 //
 // This option can be used when you want to separate the versioning of the workflow code and
@@ -412,19 +409,15 @@ const DefaultVersion Version = internal.DefaultVersion
 //
 // ExecuteWithVersion option is useful when you want to ensure that your changes can be safely rolled back if needed, as
 // both versions of the workflow code are compatible with each other.
-func ExecuteWithVersion(version Version) GetVersionOption {
-	return func(o *internal.GetVersionOptions) {
-		o.CustomVersion = &version
-	}
+func ExecuteWithVersion(version Version) internal.GetVersionOptions {
+	return internal.ExecuteWithVersion(version)
 }
 
-// ExecuteWithMinVersion returns a GetVersionOption that makes GetVersion return minSupported version
+// ExecuteWithMinVersion returns a GetVersionOptions that makes GetVersion return minSupported version
 // when executed for the first time, instead of returning maxSupported version.
 // To see how this option can be used, see the ExecuteWithVersion option
-func ExecuteWithMinVersion() GetVersionOption {
-	return func(o *internal.GetVersionOptions) {
-		o.UseMinVersion = true
-	}
+func ExecuteWithMinVersion() internal.GetVersionOptions {
+	return internal.ExecuteWithMinVersion()
 }
 
 // GetVersion is used to safely perform backwards incompatible changes to workflow definitions.
@@ -492,7 +485,7 @@ func ExecuteWithMinVersion() GetVersionOption {
 //	} else {
 //	  err = workflow.ExecuteActivity(ctx, qux, data).Get(ctx, nil)
 //	}
-func GetVersion(ctx Context, changeID string, minSupported, maxSupported Version, opts ...GetVersionOption) Version {
+func GetVersion(ctx Context, changeID string, minSupported, maxSupported Version, opts ...internal.GetVersionOptions) Version {
 	return internal.GetVersion(ctx, changeID, minSupported, maxSupported, opts...)
 }