IWF-232: Add disabling sticky cache option

.github/workflows/ci-cadence-integ-test.yml

@@ -9,12 +9,18 @@ jobs:
   tests:
     name: "Integration testing"
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        test-subset:
+          - "a-m"
+          - "n-z"
     steps:
       - uses: actions/checkout@v3
       - name: "Set up cadence environment"
         run: docker compose -f docker-compose/ci-cadence-dependencies.yml up -d
       - name: "Test against cadence"
-        run: make ci-cadence-integ-test
+        run: make ci-cadence-integ-test startsWith=${{ matrix['test-subset'] }}
       - name: Dump docker logs
         if: always()
         uses: jwalton/gh-docker-logs@v2

.github/workflows/ci-temporal-integ-test.yml

@@ -13,12 +13,19 @@ jobs:
       # Give the default GITHUB_TOKEN write permission to commit and push the
       # added or changed files to the repository.
       contents: write
+    strategy:
+      fail-fast: false
+      matrix:
+        test-subset:
+          - "a-m"
+          - "n-z"
+
     steps:
       - uses: actions/checkout@v3
       - name: "Set up temporal environment"
         run: docker compose -f docker-compose/ci-temporal-dependencies.yml up -d
       - name: "Test against temporal"
-        run: make ci-temporal-integ-test
+        run: make ci-temporal-integ-test startsWith=${{ matrix['test-subset'] }}
       - name: Dump docker logs
         if: always()
         uses: jwalton/gh-docker-logs@v2

Makefile

@@ -177,10 +177,18 @@ cadenceIntegTests:
 	$Q go test -v ./integ -temporal=false
 
 ci-cadence-integ-test:
-	$Q go test -v ./integ -search=false -temporal=false -dependencyWaitSeconds=180
+ifeq (${startsWith},)
+	$Q go test -v ./integ -search=false -temporal=false -dependencyWaitSeconds=180 -disableStickyCache=true
+else
+	$Q go test -v ./integ -run "(?i)^Test[${startsWith}]" -search=false -temporal=false -dependencyWaitSeconds=180 -disableStickyCache=true
+endif
 
 ci-temporal-integ-test:
-	$Q go test -v ./integ  -cover -coverprofile coverage.out -coverpkg ./service/... -search=false -cadence=false -dependencyWaitSeconds=60
+ifeq (${startsWith},)
+	$Q go test -v ./integ -cover -coverprofile coverage.out -coverpkg ./service/... -search=false -cadence=false -dependencyWaitSeconds=60 -disableStickyCache=true
+else
+	$Q go test -v ./integ -run "(?i)^Test[${startsWith}]" -cover -coverprofile coverage.out -coverpkg ./service/... -search=false -cadence=false -dependencyWaitSeconds=60 -disableStickyCache=true
+endif
 
 ci-all-tests:
  	# Fails CI when used with -coverprofile flag due to tests that panic; see https://go.dev/doc/build-cover#panicprof

integ/flag.go

@@ -19,3 +19,5 @@ var searchWaitTimeIntegTest = flag.Int("searchWaitMs", 2000, "the amount of time
 var temporalHostPort = flag.String("temporalHostPort", "", "temporal host port")
 
 var dependencyWaitSeconds = flag.Int("dependencyWaitSeconds", 60, "the number of seconds waiting for dependencies to be up(Cadence/Temporal)")
+
+var disableStickyCache = flag.Bool("disableStickyCache", false, "disable Temporal/Cadence sticky execution")

integ/util.go

@@ -124,7 +124,7 @@ func doStartIwfServiceWithClient(config IwfServiceTestConfig) (uclient uclient.U
 
 		// start iwf interpreter worker
 		interpreter := temporal.NewInterpreterWorker(createTestConfig(config), temporalClient, service.TaskQueue, config.MemoEncryption, dataConverter, uclient)
-		interpreter.Start()
+		interpreter.StartWithOptions(temporal.StartOptions{DisableStickyCache: *disableStickyCache})
 		return uclient, func() {
 			iwfServer.Close()
 			interpreter.Close()
@@ -155,7 +155,7 @@ func doStartIwfServiceWithClient(config IwfServiceTestConfig) (uclient uclient.U
 
 		// start iwf interpreter worker
 		interpreter := cadence.NewInterpreterWorker(createTestConfig(config), serviceClient, iwf.DefaultCadenceDomain, service.TaskQueue, closeFunc, uclient)
-		interpreter.Start()
+		interpreter.StartWithOptions(cadence.StartOptions{DisableStickyCache: *disableStickyCache})
 		return uclient, func() {
 			iwfServer.Close()
 			interpreter.Close()

service/interpreter/cadence/worker.go

@@ -19,6 +19,11 @@ type InterpreterWorker struct {
 	tasklist  string
 }
 
+type StartOptions struct {
+	// When DisableStickyCache is true it can harm performance; should not be used in production environment
+	DisableStickyCache bool
+}
+
 func NewInterpreterWorker(
 	config config.Config, service workflowserviceclient.Interface, domain, tasklist string, closeFunc func(),
 	unifiedClient uclient.UnifiedClient,
@@ -38,11 +43,25 @@ func (iw *InterpreterWorker) Close() {
 }
 
 func (iw *InterpreterWorker) Start() {
+	var options StartOptions
+
+	// default options
+	options.DisableStickyCache = false
+
+	iw.StartWithOptions(options)
+}
+
+func (iw *InterpreterWorker) StartWithOptions(startOptions StartOptions) {
 	config := env.GetSharedConfig()
 	options := worker.Options{
 		MaxConcurrentActivityTaskPollers: 10,
 		MaxConcurrentDecisionTaskPollers: 10,
 	}
+
+	if startOptions.DisableStickyCache {
+		options.DisableStickyExecution = true
+	}
+
 	if config.Interpreter.Cadence != nil && config.Interpreter.Cadence.WorkerOptions != nil {
 		options = *config.Interpreter.Cadence.WorkerOptions
 	}

service/interpreter/temporal/worker.go

@@ -18,6 +18,11 @@ type InterpreterWorker struct {
 	taskQueue      string
 }
 
+type StartOptions struct {
+	// When DisableStickyCache is true it can harm performance; should not be used in production environment
+	DisableStickyCache bool
+}
+
 func NewInterpreterWorker(
 	config config.Config, temporalClient client.Client, taskQueue string, memoEncryption bool,
 	memoEncryptionConverter converter.DataConverter, unifiedClient uclient.UnifiedClient,
@@ -36,6 +41,15 @@ func (iw *InterpreterWorker) Close() {
 }
 
 func (iw *InterpreterWorker) Start() {
+	var options StartOptions
+
+	// default options
+	options.DisableStickyCache = false
+
+	iw.StartWithOptions(options)
+}
+
+func (iw *InterpreterWorker) StartWithOptions(startOptions StartOptions) {
 	config := env.GetSharedConfig()
 	options := worker.Options{
 		MaxConcurrentActivityTaskPollers: 10,
@@ -49,6 +63,10 @@ func (iw *InterpreterWorker) Start() {
 	iw.worker = worker.New(iw.temporalClient, iw.taskQueue, options)
 	worker.EnableVerboseLogging(config.Interpreter.VerboseDebug)
 
+	if startOptions.DisableStickyCache {
+		worker.SetStickyWorkflowCacheSize(0)
+	}
+
 	iw.worker.RegisterWorkflow(Interpreter)
 	iw.worker.RegisterWorkflow(WaitforStateCompletionWorkflow)
 	iw.worker.RegisterActivity(interpreter.StateStart)  // TODO: remove in next release