change usage of internal.GetVersionOption to GetVersionOption.apply interface

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 ...GetVersionOptions) Version
+	GetVersion(ctx Context, changeID string, minSupported, maxSupported Version, opts ...GetVersionOption) 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 ...GetVersionOptions) Version {
+func (t *WorkflowInterceptorBase) GetVersion(ctx Context, changeID string, minSupported, maxSupported Version, opts ...GetVersionOption) 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 ...GetVersionOptions) Version {
+func (wc *workflowEnvironmentImpl) GetVersion(changeID string, minSupported, maxSupported Version, opts ...GetVersionOption) 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
 	}
 
-	// Use the first option if they're present
-	var options GetVersionOptions
-	if len(opts) > 0 {
-		options = opts[0]
+	// Apply the functional options to get the configuration
+	config := &getVersionConfig{}
+	for _, opt := range opts {
+		opt.apply(config)
 	}
 
 	var version Version
@@ -625,11 +625,11 @@ func (wc *workflowEnvironmentImpl) GetVersion(changeID string, minSupported, max
 		version = DefaultVersion
 
 	// If ExecuteWithVersion option is used, use the custom version provided
-	case options.CustomVersion != nil:
-		version = *options.CustomVersion
+	case config.CustomVersion != nil:
+		version = *config.CustomVersion
 
 	// If ExecuteWithMinVersion option is set, use the minimum supported version
-	case options.UseMinVersion:
+	case config.UseMinVersion:
 		version = minSupported
 
 	// Otherwise, use the maximum supported 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 ...GetVersionOptions) Version
+		GetVersion(changeID string, minSupported, maxSupported Version, opts ...GetVersionOption) 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 ...GetVersionOptions) (retVersion Version) {
+func (env *testWorkflowEnvironmentImpl) GetVersion(changeID string, minSupported, maxSupported Version, opts ...GetVersionOption) (retVersion Version) {
 	if mockVersion, ok := env.getMockedVersion(changeID, changeID, minSupported, maxSupported); ok {
 		// GetVersion for changeID is mocked
 		env.UpsertSearchAttributes(createSearchAttributesForChangeVersion(changeID, mockVersion, env.changeVersions))
@@ -1948,21 +1948,21 @@ func (env *testWorkflowEnvironmentImpl) GetVersion(changeID string, minSupported
 		return version
 	}
 
-	// Use the first option if they're present
-	var options GetVersionOptions
-	if len(opts) > 0 {
-		options = opts[0]
+	// Apply the functional options to get the configuration
+	config := &getVersionConfig{}
+	for _, opt := range opts {
+		opt.apply(config)
 	}
 
 	// Determine the version to use based on the options provided
 	var version Version
 	switch {
 	// If ExecuteWithVersion option is used, use the custom version provided
-	case options.CustomVersion != nil:
-		version = *options.CustomVersion
+	case config.CustomVersion != nil:
+		version = *config.CustomVersion
 
 	// If ExecuteWithMinVersion option is set, use the minimum supported version
-	case options.UseMinVersion:
+	case config.UseMinVersion:
 		version = minSupported
 
 	// Otherwise, use the maximum supported version

internal/workflow.go

@@ -1567,8 +1567,13 @@ const DefaultVersion Version = -1
 // CadenceChangeVersion is used as search attributes key to find workflows with specific change version.
 const CadenceChangeVersion = "CadenceChangeVersion"
 
-// GetVersionOptions contains options for GetVersion
-type GetVersionOptions struct {
+// GetVersionOption is an interface for functional options that can be applied to GetVersion
+type GetVersionOption interface {
+	apply(*getVersionConfig)
+}
+
+// getVersionConfig holds the configuration for GetVersion
+type getVersionConfig struct {
 	// CustomVersion is used to force GetVersion to return a specific version
 	// instead of maxSupported version. Set up via ExecuteWithVersion option.
 	CustomVersion *Version
@@ -1578,75 +1583,39 @@ type GetVersionOptions struct {
 	UseMinVersion bool
 }
 
+// customVersionOption forces GetVersion to return a specific version
+type customVersionOption Version
+
+func (c customVersionOption) apply(config *getVersionConfig) {
+	version := Version(c)
+	config.CustomVersion = &version
+}
+
 // ExecuteWithVersion forces a specific version to be returned when GetVersion is 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
-// activation of the new logic in the workflow code, to ensure that your changes can be safely rolled back, if needed.
-//
-// For example, initially a workflow has the following code:
-//
-//	err = workflow.ExecuteActivity(ctx, foo).Get(ctx, nil)
-//
-// It should be updated to:
-//
-//	err = workflow.ExecuteActivity(ctx, bar).Get(ctx, nil)
-//
-// Following the steps below, your changes will be forward and backward compatible, keeping possible a safe rollback
-// to the previous version of the workflow code:
-//
-// 1. Keep execution of foo activity, add a support of bar activity
-//
-//	v := GetVersion(ctx, "fooChange", DefaultVersion, 1,  ExecuteWithVersion(DefaultVersion))
-//	if v == DefaultVersion {
-//		err = workflow.ExecuteActivity(ctx, foo).Get(ctx, nil)
-//	} else {
-//		err = workflow.ExecuteActivity(ctx, bar).Get(ctx, nil)
-//	}
-//
-// The code above supports replaying of workflow execution with both versions DefaultVersion and 1.
-// All new workflow executions will execute foo activity, because GetVersion with ExecuteWithMinVersion option
-// returns DefaultVersion, that will be recorded into the workflow history.
-//
-// 2. Enable execution of bar activity
-//
-//	v := GetVersion(ctx, "fooChange", DefaultVersion, 1)
-//	if v == DefaultVersion {
-//	    err = workflow.ExecuteActivity(ctx, foo).Get(ctx, nil)
-//	} else {
-//	    err = workflow.ExecuteActivity(ctx, bar).Get(ctx, nil)
-//	}
-//
-// The code above supports replaying of workflow execution with both versions DefaultVersion and 1.
-// All new workflow executions will execute bar activity, because
-// GetVersion returns the maximum supported version - 1, that will be recorded into the workflow history.
-//
-// 3. Remove a support of foo activity:
-//
-//	GetVersion(ctx, "fooChange", 1, 1)
-//	err = workflow.ExecuteActivity(ctx, bar).Get(ctx, nil)
-//
-// When there are no workflow executions running DefaultVersion the support of foo activity can be removed.
-//
-// ExecuteWithVersion option is useful when you want to ensure that your changes can be safely rolled back if needed.
-func ExecuteWithVersion(version Version) GetVersionOptions {
-	return GetVersionOptions{
-		CustomVersion: &version,
-	}
+// instead of returning maxSupported version. Check public documentation of workflow.ExecuteWithVersion
+func ExecuteWithVersion(version Version) GetVersionOption {
+	return customVersionOption(version)
+}
+
+// useMinVersionOption forces GetVersion to return minSupported version
+type useMinVersionOption struct{}
+
+func (useMinVersionOption) apply(config *getVersionConfig) {
+	config.UseMinVersion = true
 }
 
 // ExecuteWithMinVersion forces minSupported version to be returned when GetVersion is executed for the first time,
-// instead of returning maxSupported version. The option is equivalent to ExecuteWithVersion(minSupportedVersion).
-// Check the ExecuteWithVersion documentation for more details.
-func ExecuteWithMinVersion() GetVersionOptions {
-	return GetVersionOptions{
-		UseMinVersion: true,
-	}
+// instead of returning maxSupported version. Check public documentation of workflow.ExecuteWithMinVersion
+func ExecuteWithMinVersion() GetVersionOption {
+	return useMinVersionOption{}
 }
 
 // GetVersion is used to safely perform backwards incompatible changes to workflow definitions.
 // It is not allowed to update workflow code while there are workflows running as it is going to break
 // determinism. The solution is to have both old code that is used to replay existing workflows
 // as well as the new one that is used when it is executed for the first time.
-// GetVersion returns maxSupported version (to return another version, check GetVersionOption),
+// GetVersion returns maxSupported version
+// (to return another version for a potential safe rollback, check documentation for ExecuteWithVersion and ExecuteWithMinVersion),
 // when is executed for the first time. This version is recorded into the
 // workflow history as a marker event. Even if maxSupported version is changed the version that was recorded is
 // returned on replay. DefaultVersion constant contains version of code that wasn't versioned before.
@@ -1708,12 +1677,12 @@ func ExecuteWithMinVersion() GetVersionOptions {
 //	} else {
 //	  err = workflow.ExecuteActivity(ctx, qux, data).Get(ctx, nil)
 //	}
-func GetVersion(ctx Context, changeID string, minSupported, maxSupported Version, opts ...GetVersionOptions) Version {
+func GetVersion(ctx Context, changeID string, minSupported, maxSupported Version, opts ...GetVersionOption) Version {
 	i := getWorkflowInterceptor(ctx)
 	return i.GetVersion(ctx, changeID, minSupported, maxSupported, opts...)
 }
 
-func (wc *workflowEnvironmentInterceptor) GetVersion(ctx Context, changeID string, minSupported, maxSupported Version, opts ...GetVersionOptions) Version {
+func (wc *workflowEnvironmentInterceptor) GetVersion(ctx Context, changeID string, minSupported, maxSupported Version, opts ...GetVersionOption) Version {
 	return wc.env.GetVersion(changeID, minSupported, maxSupported, opts...)
 }
 

workflow/workflow.go

@@ -59,6 +59,9 @@ type (
 	Info = internal.WorkflowInfo
 
 	RegistryInfo = internal.RegistryWorkflowInfo
+
+	// GetVersionOption is used to specify options for GetVersion
+	GetVersionOption = internal.GetVersionOption
 )
 
 // Register - registers a workflow function with the framework.
@@ -401,22 +404,24 @@ const DefaultVersion Version = internal.DefaultVersion
 //	err = workflow.ExecuteActivity(ctx, bar).Get(ctx, nil)
 //
 // When there are no workflow executions running DefaultVersion the support of foo activity can be removed.
-func ExecuteWithVersion(version Version) internal.GetVersionOptions {
+func ExecuteWithVersion(version Version) GetVersionOption {
 	return internal.ExecuteWithVersion(version)
 }
 
 // ExecuteWithMinVersion forces minSupported version to be returned when GetVersion is executed for the first time,
 // instead of returning maxSupported version. The option is equivalent to ExecuteWithVersion(minSupportedVersion).
 // Check the ExecuteWithVersion documentation for more details.
-func ExecuteWithMinVersion() internal.GetVersionOptions {
+func ExecuteWithMinVersion() GetVersionOption {
 	return internal.ExecuteWithMinVersion()
 }
 
 // GetVersion is used to safely perform backwards incompatible changes to workflow definitions.
 // It is not allowed to update workflow code while there are workflows running as it is going to break
 // determinism. The solution is to have both old code that is used to replay existing workflows
 // as well as the new one that is used when it is executed for the first time.
-// GetVersion returns maxSupported version when is executed for the first time. This version is recorded into the
+// GetVersion returns maxSupported version
+// (to return another version for a potential safe rollback, check documentation for ExecuteWithVersion and ExecuteWithMinVersion),
+// when is executed for the first time. This version is recorded into the
 // workflow history as a marker event. Even if maxSupported version is changed the version that was recorded is
 // returned on replay. DefaultVersion constant contains version of code that wasn't versioned before.
 // For example initially workflow has the following code:
@@ -477,7 +482,7 @@ func ExecuteWithMinVersion() internal.GetVersionOptions {
 //	} else {
 //	  err = workflow.ExecuteActivity(ctx, qux, data).Get(ctx, nil)
 //	}
-func GetVersion(ctx Context, changeID string, minSupported, maxSupported Version, opts ...internal.GetVersionOptions) Version {
+func GetVersion(ctx Context, changeID string, minSupported, maxSupported Version, opts ...GetVersionOption) Version {
 	return internal.GetVersion(ctx, changeID, minSupported, maxSupported, opts...)
 }