Make shadowOptions optional in workerOptions (#1087)

Author: yycptt

internal/internal_worker_test.go

@@ -382,7 +382,7 @@ func createWorkerWithThrottle(
 
 	if shadowOptions != nil {
 		workerOptions.EnableShadowWorker = true
-		workerOptions.ShadowOptions = shadowOptions
+		workerOptions.ShadowOptions = *shadowOptions
 	}
 
 	// Start Worker.

internal/worker.go

@@ -218,10 +218,9 @@ type (
 		// default: false
 		EnableShadowWorker bool
 
-		// Required if EnableShadowWorker is set to true
-		// Configures workflow shadowing details
-		// default: no defaults
-		ShadowOptions *ShadowOptions
+		// Optional: Configures shadowing workflow
+		// default: please check the documentation for ShadowOptions for default options
+		ShadowOptions ShadowOptions
 	}
 )
 

internal/workflow_shadower_worker.go

@@ -22,7 +22,6 @@ package internal
 
 import (
 	"context"
-	"errors"
 
 	"github.com/opentracing/opentracing-go"
 	"github.com/pborman/uuid"
@@ -41,15 +40,15 @@ type (
 		service  workflowserviceclient.Interface
 		domain   string
 		taskList string
-		options  *ShadowOptions
+		options  ShadowOptions
 		logger   *zap.Logger
 	}
 )
 
 func newShadowWorker(
 	service workflowserviceclient.Interface,
 	domain string,
-	shadowOptions *ShadowOptions,
+	shadowOptions ShadowOptions,
 	params workerExecutionParameters,
 	registry *registry,
 ) *shadowWorker {
@@ -109,10 +108,6 @@ func newShadowWorker(
 }
 
 func (sw *shadowWorker) Start() error {
-	if sw.options == nil {
-		return errors.New("shadowerOptions must be specified when shadow worker is enabled")
-	}
-
 	if err := sw.options.validateAndPopulateFields(); err != nil {
 		return err
 	}

internal/workflow_shadower_worker_test.go

@@ -64,7 +64,7 @@ func (s *shadowWorkerSuite) TestNewShadowWorker() {
 	shadowWorker := newShadowWorker(
 		s.mockService,
 		testDomain,
-		&ShadowOptions{},
+		ShadowOptions{},
 		workerExecutionParameters{
 			TaskList: testTaskList,
 		},
@@ -88,25 +88,11 @@ func (s *shadowWorkerSuite) TestNewShadowWorker() {
 	s.Contains(taskList, testDomain)
 }
 
-func (s *shadowWorkerSuite) TestStartShadowWorker_Failed_ShadowOptionNotSpecified() {
-	shadowWorker := newShadowWorker(
-		s.mockService,
-		testDomain,
-		nil,
-		workerExecutionParameters{
-			TaskList: testTaskList,
-		},
-		newRegistry(),
-	)
-
-	s.Error(shadowWorker.Start())
-}
-
 func (s *shadowWorkerSuite) TestStartShadowWorker_Failed_InvalidShadowOption() {
 	shadowWorker := newShadowWorker(
 		s.mockService,
 		testDomain,
-		&ShadowOptions{
+		ShadowOptions{
 			Mode: ShadowModeContinuous, // exit condition is not specified
 		},
 		workerExecutionParameters{
@@ -126,7 +112,7 @@ func (s *shadowWorkerSuite) TestStartShadowWorker_Failed_DomainNotExist() {
 	shadowWorker := newShadowWorker(
 		s.mockService,
 		testDomain,
-		&ShadowOptions{},
+		ShadowOptions{},
 		workerExecutionParameters{
 			TaskList: testTaskList,
 		},
@@ -144,7 +130,7 @@ func (s *shadowWorkerSuite) TestStartShadowWorker_Failed_TaskListNotSpecified()
 	shadowWorker := newShadowWorker(
 		s.mockService,
 		testDomain,
-		&ShadowOptions{},
+		ShadowOptions{},
 		workerExecutionParameters{},
 		newRegistry(),
 	)
@@ -164,7 +150,7 @@ func (s *shadowWorkerSuite) TestStartShadowWorker_Failed_StartWorkflowError() {
 	shadowWorker := newShadowWorker(
 		s.mockService,
 		testDomain,
-		&ShadowOptions{},
+		ShadowOptions{},
 		workerExecutionParameters{
 			TaskList: testTaskList,
 		},
@@ -200,7 +186,7 @@ func (s *shadowWorkerSuite) TestStartShadowWorker_Succeed() {
 	shadowWorker := newShadowWorker(
 		s.mockService,
 		testDomain,
-		&ShadowOptions{
+		ShadowOptions{
 			WorkflowQuery: workflowQuery,
 			SamplingRate:  samplingRate,
 			Mode:          shadowMode,