From bf3ea1194e3863738b77a935345f2823c6ff975c Mon Sep 17 00:00:00 2001 From: Quanzheng Long Date: Sat, 11 May 2024 15:07:42 -0700 Subject: [PATCH] Rename versioning optimization flag (#382) --- integ/basic_test.go | 4 +--- integ/config.go | 4 ++-- integ/locking_test.go | 3 +-- integ/persistence_test.go | 3 +-- integ/start_delay_test.go | 3 +-- integ/util.go | 10 +++++----- service/api/service.go | 4 ++-- service/common/config/config.go | 15 ++------------- service/interfaces.go | 2 +- service/interpreter/workflowImpl.go | 3 +-- 10 files changed, 17 insertions(+), 34 deletions(-) diff --git a/integ/basic_test.go b/integ/basic_test.go index fe8db6a6..7451f8bd 100644 --- a/integ/basic_test.go +++ b/integ/basic_test.go @@ -2,7 +2,6 @@ package integ import ( "context" - config2 "github.com/indeedeng/iwf/service/common/config" "github.com/indeedeng/iwf/service/common/ptr" "log" "strconv" @@ -52,8 +51,7 @@ func doTestBasicWorkflow(t *testing.T, backendType service.BackendType, config * defer closeFunc1() _, closeFunc2 := startIwfServiceByConfig(IwfServiceTestConfig{ - BackendType: backendType, - OptimizationVersion: ptr.Any(config2.OptimizationVersionNone), + BackendType: backendType, }) defer closeFunc2() diff --git a/integ/config.go b/integ/config.go index a681759e..4db2acca 100644 --- a/integ/config.go +++ b/integ/config.go @@ -7,12 +7,12 @@ import ( const testWorkflowServerPort = "9714" const testIwfServerPort = "9715" -func createTestConfig(failAtMemoCompatibility bool, optimizationVersion *int) config.Config { +func createTestConfig(failAtMemoCompatibility bool, optimizedVersioning *bool) config.Config { return config.Config{ Api: config.ApiConfig{ Port: 9715, MaxWaitSeconds: 10, // use 10 so that we can test it in the waiting test - OptimizationVersion: optimizationVersion, + OptimizedVersioning: optimizedVersioning, }, Interpreter: config.Interpreter{ VerboseDebug: false, diff --git a/integ/locking_test.go b/integ/locking_test.go index 88dbb7c7..45e29018 100644 --- a/integ/locking_test.go +++ b/integ/locking_test.go @@ -5,7 +5,6 @@ import ( "encoding/json" "fmt" "github.com/indeedeng/iwf/integ/workflow/locking" - config2 "github.com/indeedeng/iwf/service/common/config" "github.com/indeedeng/iwf/service/common/ptr" "io/ioutil" "strconv" @@ -66,7 +65,7 @@ func doTestLockingWorkflow(t *testing.T, backendType service.BackendType, config _, closeFunc2 := startIwfServiceByConfig(IwfServiceTestConfig{ BackendType: backendType, DisableFailAtMemoIncompatibility: true, - OptimizationVersion: ptr.Any(config2.OptimizationVersionV1), + OptimizedVersioning: ptr.Any(true), }) defer closeFunc2() diff --git a/integ/persistence_test.go b/integ/persistence_test.go index b8e38e38..65b76565 100644 --- a/integ/persistence_test.go +++ b/integ/persistence_test.go @@ -3,7 +3,6 @@ package integ import ( "context" "fmt" - config2 "github.com/indeedeng/iwf/service/common/config" "github.com/indeedeng/iwf/service/common/ptr" "github.com/indeedeng/iwf/service/common/timeparser" "log" @@ -108,7 +107,7 @@ func doTestPersistenceWorkflow( uclient, closeFunc2 := startIwfServiceByConfig(IwfServiceTestConfig{ BackendType: backendType, MemoEncryption: memoEncryption, - OptimizationVersion: ptr.Any(config2.OptimizationVersionV1), + OptimizedVersioning: ptr.Any(true), }) defer closeFunc2() diff --git a/integ/start_delay_test.go b/integ/start_delay_test.go index 4d1106e2..60c14b65 100644 --- a/integ/start_delay_test.go +++ b/integ/start_delay_test.go @@ -5,7 +5,6 @@ import ( "github.com/indeedeng/iwf/gen/iwfidl" "github.com/indeedeng/iwf/integ/workflow/basic" "github.com/indeedeng/iwf/service" - config2 "github.com/indeedeng/iwf/service/common/config" "github.com/indeedeng/iwf/service/common/ptr" "github.com/stretchr/testify/assert" "strconv" @@ -35,7 +34,7 @@ func doTestStartDelay(t *testing.T, backendType service.BackendType, config *iwf _, closeFunc2 := startIwfServiceByConfig(IwfServiceTestConfig{ BackendType: backendType, - OptimizationVersion: ptr.Any(config2.OptimizationVersionNone), + OptimizedVersioning: ptr.Any(false), }) defer closeFunc2() diff --git a/integ/util.go b/integ/util.go index 0e6b1c81..a32f5244 100644 --- a/integ/util.go +++ b/integ/util.go @@ -66,7 +66,7 @@ type IwfServiceTestConfig struct { BackendType service.BackendType MemoEncryption bool DisableFailAtMemoIncompatibility bool // default to false so that we will fail at test - OptimizationVersion *int + OptimizedVersioning *bool } func startIwfService(backendType service.BackendType) (closeFunc func()) { @@ -111,7 +111,7 @@ func doStartIwfServiceWithClient(config IwfServiceTestConfig) (uclient uclient.U panic(err) } uclient = temporalapi.NewTemporalClient(temporalClient, testNamespace, dataConverter, config.MemoEncryption) - iwfService := api.NewService(createTestConfig(failAtMemoIncompatibility, config.OptimizationVersion), uclient, logger) + iwfService := api.NewService(createTestConfig(failAtMemoIncompatibility, config.OptimizedVersioning), uclient, logger) iwfServer := &http.Server{ Addr: ":" + testIwfServerPort, Handler: iwfService, @@ -123,7 +123,7 @@ func doStartIwfServiceWithClient(config IwfServiceTestConfig) (uclient uclient.U }() // start iwf interpreter worker - interpreter := temporal.NewInterpreterWorker(createTestConfig(failAtMemoIncompatibility, config.OptimizationVersion), temporalClient, service.TaskQueue, config.MemoEncryption, dataConverter, uclient) + interpreter := temporal.NewInterpreterWorker(createTestConfig(failAtMemoIncompatibility, config.OptimizedVersioning), temporalClient, service.TaskQueue, config.MemoEncryption, dataConverter, uclient) interpreter.Start() return uclient, func() { iwfServer.Close() @@ -142,7 +142,7 @@ func doStartIwfServiceWithClient(config IwfServiceTestConfig) (uclient uclient.U panic(err) } uclient = cadenceapi.NewCadenceClient(iwf.DefaultCadenceDomain, cadenceClient, serviceClient, encoded.GetDefaultDataConverter(), closeFunc) - iwfService := api.NewService(createTestConfig(failAtMemoIncompatibility, config.OptimizationVersion), uclient, logger) + iwfService := api.NewService(createTestConfig(failAtMemoIncompatibility, config.OptimizedVersioning), uclient, logger) iwfServer := &http.Server{ Addr: ":" + testIwfServerPort, Handler: iwfService, @@ -154,7 +154,7 @@ func doStartIwfServiceWithClient(config IwfServiceTestConfig) (uclient uclient.U }() // start iwf interpreter worker - interpreter := cadence.NewInterpreterWorker(createTestConfig(failAtMemoIncompatibility, config.OptimizationVersion), serviceClient, iwf.DefaultCadenceDomain, service.TaskQueue, closeFunc, uclient) + interpreter := cadence.NewInterpreterWorker(createTestConfig(failAtMemoIncompatibility, config.OptimizedVersioning), serviceClient, iwf.DefaultCadenceDomain, service.TaskQueue, closeFunc, uclient) interpreter.Start() return uclient, func() { iwfServer.Close() diff --git a/service/api/service.go b/service/api/service.go index 2bf90cb6..c4f9e0b2 100644 --- a/service/api/service.go +++ b/service/api/service.go @@ -57,7 +57,7 @@ func (s *serviceImpl) ApiV1WorkflowStartPost( defer func() { log.CapturePanic(recover(), s.logger, &retError) }() var sysSAs map[string]interface{} - if config.IsVersioningOptimized(s.config.Api.OptimizationVersion) { + if s.config.Api.OptimizedVersioning != nil && *s.config.Api.OptimizedVersioning { sysSAs = map[string]interface{}{ service.SearchAttributeIwfWorkflowType: req.IwfWorkflowType, service.SearchAttributeGlobalVersion: versions.MaxOfAllVersions, @@ -130,7 +130,7 @@ func (s *serviceImpl) ApiV1WorkflowStartPost( Config: workflowConfig, UseMemoForDataAttributes: useMemo, WaitForCompletionStateExecutionIds: req.GetWaitForCompletionStateExecutionIds(), - OptimizationVersion: s.config.Api.OptimizationVersion, + OmitVersionMarker: s.config.Api.OptimizedVersioning, } runId, err := s.client.StartInterpreterWorkflow(ctx, workflowOptions, input) diff --git a/service/common/config/config.go b/service/common/config/config.go index ba79a5e0..7e75b44b 100644 --- a/service/common/config/config.go +++ b/service/common/config/config.go @@ -26,8 +26,8 @@ type ( // Port is the port on which the API service will bind to Port int `yaml:"port"` MaxWaitSeconds int64 `yaml:"maxWaitSeconds"` - // OptimizationVersion is the flag to use optimization - OptimizationVersion *int `yaml:"optimizationVersion"` + // OptimizedVersioning is the versioning optimization flag + OptimizedVersioning *bool `yaml:"optimizedVersioning"` } Interpreter struct { @@ -91,17 +91,6 @@ type ( } ) -const ( - // OptimizationVersionNone is not doing any optimization. This is the default optimization version - OptimizationVersionNone = 0 - // OptimizationVersionV1 is for optimizing the workflow actions(version marker, upsertSearchAttribute) - OptimizationVersionV1 = 1 -) - -func IsVersioningOptimized(version *int) bool { - return version != nil && *version >= OptimizationVersionV1 -} - var DefaultWorkflowConfig = &iwfidl.WorkflowConfig{ ContinueAsNewThreshold: iwfidl.PtrInt32(100), DisableSystemSearchAttribute: iwfidl.PtrBool(true), diff --git a/service/interfaces.go b/service/interfaces.go index 5efe9b26..65015b4b 100644 --- a/service/interfaces.go +++ b/service/interfaces.go @@ -30,7 +30,7 @@ type ( ContinueAsNewInput *ContinueAsNewInput `json:"continueAsNewInput,omitempty"` - OptimizationVersion *int `json:"optmn,omitempty"` + OmitVersionMarker *bool `json:"omtVers,omitempty"` } ContinueAsNewInput struct { diff --git a/service/interpreter/workflowImpl.go b/service/interpreter/workflowImpl.go index 3d1ed9b1..7b0940fd 100644 --- a/service/interpreter/workflowImpl.go +++ b/service/interpreter/workflowImpl.go @@ -4,7 +4,6 @@ import ( "context" "fmt" uclient "github.com/indeedeng/iwf/service/client" - "github.com/indeedeng/iwf/service/common/config" "github.com/indeedeng/iwf/service/interpreter/env" "time" @@ -19,7 +18,7 @@ func InterpreterImpl( ctx UnifiedContext, provider WorkflowProvider, input service.InterpreterWorkflowInput, ) (*service.InterpreterWorkflowOutput, error) { var err error - globalVersioner, err := NewGlobalVersioner(provider, config.IsVersioningOptimized(input.OptimizationVersion), ctx) + globalVersioner, err := NewGlobalVersioner(provider, input.OmitVersionMarker != nil && *input.OmitVersionMarker, ctx) if err != nil { return nil, err }