refactor(BUX-411): localCron as the only cron service

Author: chris-4chain

bux_suite_mocks_test.go

@@ -32,10 +32,6 @@ func (tm *taskManagerMockBase) Close(context.Context) error {
 
 func (tm *taskManagerMockBase) Debug(bool) {}
 
-func (tm *taskManagerMockBase) Engine() taskmanager.Engine {
-	return taskmanager.Empty
-}
-
 func (tm *taskManagerMockBase) Factory() taskmanager.Factory {
 	return taskmanager.FactoryEmpty
 }

client_options.go

@@ -574,15 +574,6 @@ func WithTaskQUsingRedis(config *taskq.QueueOptions, redisOptions *redis.Options
 	}
 }
 
-// WithCronService will set the custom cron service provider
-func WithCronService(cronService taskmanager.CronService) ClientOps {
-	return func(c *clientOptions) {
-		if cronService != nil && c.taskManager != nil {
-			c.taskManager.options = append(c.taskManager.options, taskmanager.WithCronService(cronService))
-		}
-	}
-}
-
 // WithCronCustmPeriod will set the custom cron jobs period which will override the default
 func WithCronCustmPeriod(cronJobName string, period time.Duration) ClientOps {
 	return func(c *clientOptions) {

client_options_test.go

@@ -485,7 +485,6 @@ func TestWithTaskQ(t *testing.T) {
 
 		tm := tc.Taskmanager()
 		require.NotNil(t, tm)
-		assert.Equal(t, taskmanager.TaskQ, tm.Engine())
 		assert.Equal(t, taskmanager.FactoryMemory, tm.Factory())
 	})
 
@@ -517,7 +516,6 @@ func TestWithTaskQ(t *testing.T) {
 
 		tm := tc.Taskmanager()
 		require.NotNil(t, tm)
-		assert.Equal(t, taskmanager.TaskQ, tm.Engine())
 		assert.Equal(t, taskmanager.FactoryRedis, tm.Factory())
 	})
 }

taskmanager/cron.go

@@ -2,14 +2,6 @@ package taskmanager
 
 import "github.com/robfig/cron/v3"
 
-// localCron will load a local version of cron if it was not provided by the user
-func (c *Client) localCron() {
-	cr := &cronLocal{}
-	cr.New()
-	cr.Start()
-	c.options.cronService = cr
-}
-
 // cronLocal is the interface for the "local cron" service
 type cronLocal struct {
 	cronService *cron.Cron

taskmanager/interface.go

@@ -6,26 +6,13 @@ import (
 	taskq "github.com/vmihailenco/taskq/v3"
 )
 
-// TaskService is the task related methods
-type TaskService interface {
+// ClientInterface is the taskmanager client interface
+type ClientInterface interface {
 	RegisterTask(task *Task) error
 	ResetCron()
 	RunTask(ctx context.Context, options *TaskOptions) error
 	Tasks() map[string]*taskq.Task
 	CronJobsInit(cronJobsMap CronJobs) error
-}
-
-// CronService is the cron service provider
-type CronService interface {
-	AddFunc(spec string, cmd func()) (int, error)
-	New()
-	Start()
-	Stop()
-}
-
-// ClientInterface is the taskmanager client interface
-type ClientInterface interface {
-	TaskService
 	Close(ctx context.Context) error
 	Debug(on bool)
 	Factory() Factory

taskmanager/taskmanager.go

@@ -18,7 +18,7 @@ type (
 
 	// clientOptions holds all the configuration for the client
 	clientOptions struct {
-		cronService     CronService     // Internal cron job client
+		cronService     *cronLocal      // Internal cron job client
 		debug           bool            // For extra logs and additional debug information
 		logger          *zerolog.Logger // Internal logging
 		newRelicEnabled bool            // If NewRelic is enabled (parent application)
@@ -56,14 +56,16 @@ func NewClient(_ context.Context, opts ...ClientOps) (ClientInterface, error) {
 	// Use NewRelic if it's enabled (use existing txn if found on ctx)
 	// ctx = client.options.getTxnCtx(ctx)
 
+	// Load the TaskQ engine
 	if err := client.loadTaskQ(); err != nil {
 		return nil, err
 	}
 
-	// Detect if a cron service provider was set
-	if client.options.cronService == nil { // Use a local cron
-		client.localCron()
-	}
+	// Create the cron scheduler
+	cr := &cronLocal{}
+	cr.New()
+	cr.Start()
+	client.options.cronService = cr
 
 	// Return the client
 	return client, nil

taskmanager/taskmanager_options.go

@@ -69,12 +69,3 @@ func WithLogger(customLogger *zerolog.Logger) ClientOps {
 		}
 	}
 }
-
-// WithCronService will set the cron service
-func WithCronService(cronService CronService) ClientOps {
-	return func(c *clientOptions) {
-		if cronService != nil {
-			c.cronService = cronService
-		}
-	}
-}

taskmanager/taskmanager_options_test.go

@@ -95,28 +95,3 @@ func TestWithLogger(t *testing.T) {
 		assert.Equal(t, &customLogger, options.logger)
 	})
 }
-
-// TestWithCronService will test the method WithCronService()
-func TestWithCronService(t *testing.T) {
-	t.Parallel()
-
-	t.Run("check type", func(t *testing.T) {
-		opt := WithCronService(nil)
-		assert.IsType(t, *new(ClientOps), opt)
-	})
-
-	t.Run("test applying nil", func(t *testing.T) {
-		options := &clientOptions{}
-		opt := WithCronService(nil)
-		opt(options)
-		assert.Nil(t, options.cronService)
-	})
-
-	t.Run("test applying option", func(t *testing.T) {
-		options := &clientOptions{}
-		customCron := &cronLocal{}
-		opt := WithCronService(customCron)
-		opt(options)
-		assert.Equal(t, customCron, options.cronService)
-	})
-}