Move WorkerName to common backend options

Co-authored-by: cschleiden <[email protected]>

Author: Copilot

backend/mysql/mysql.go

@@ -977,8 +977,8 @@ func scheduleActivity(ctx context.Context, tx *sql.Tx, queue workflow.Queue, ins
 
 // getWorkerName returns the worker name from options, or generates a UUID-based name if not set.
 func getWorkerName(options *options) string {
-	if options.WorkerName != "" {
-		return options.WorkerName
+	if options.Options.WorkerName != "" {
+		return options.Options.WorkerName
 	}
 	return fmt.Sprintf("worker-%v", uuid.NewString())
 }

backend/mysql/mysql_test.go

@@ -171,7 +171,9 @@ func Test_MysqlBackend_WorkerName(t *testing.T) {
 	t.Run("DefaultWorkerName", func(t *testing.T) {
 		// Create a backend without specifying worker name
 		// Since we can't connect to MySQL without it being available, we'll test the getWorkerName function directly
-		options := &options{}
+		options := &options{
+			Options: backend.ApplyOptions(),
+		}
 		workerName := getWorkerName(options)
 
 		// The default worker name should be in the format "worker-<uuid>"
@@ -185,7 +187,9 @@ func Test_MysqlBackend_WorkerName(t *testing.T) {
 
 	t.Run("CustomWorkerName", func(t *testing.T) {
 		customWorkerName := "test-worker-123"
-		options := &options{WorkerName: customWorkerName}
+		options := &options{
+			Options: backend.ApplyOptions(backend.WithWorkerName(customWorkerName)),
+		}
 		workerName := getWorkerName(options)
 
 		if workerName != customWorkerName {
@@ -194,7 +198,9 @@ func Test_MysqlBackend_WorkerName(t *testing.T) {
 	})
 
 	t.Run("EmptyWorkerNameUsesDefault", func(t *testing.T) {
-		options := &options{WorkerName: ""}
+		options := &options{
+			Options: backend.ApplyOptions(backend.WithWorkerName("")),
+		}
 		workerName := getWorkerName(options)
 
 		// Empty worker name should fall back to UUID generation

backend/mysql/options.go

@@ -13,21 +13,10 @@ type options struct {
 
 	// ApplyMigrations automatically applies database migrations on startup.
 	ApplyMigrations bool
-
-	// WorkerName allows setting a custom worker name. If not set, a random UUID will be generated.
-	WorkerName string
 }
 
 type option func(*options)
 
-// WithWorkerName sets a custom worker name for the MySQL backend.
-// If not provided, a random UUID will be generated.
-func WithWorkerName(workerName string) option {
-	return func(o *options) {
-		o.WorkerName = workerName
-	}
-}
-
 // WithApplyMigrations automatically applies database migrations on startup.
 func WithApplyMigrations(applyMigrations bool) option {
 	return func(o *options) {

backend/options.go

@@ -46,6 +46,9 @@ type Options struct {
 
 	// MaxHistorySize is the maximum size of a workflow history. If a workflow exceeds this size, it will be failed.
 	MaxHistorySize int64
+
+	// WorkerName allows setting a custom worker name. If not set, backends will generate a default name.
+	WorkerName string
 }
 
 var DefaultOptions Options = Options{
@@ -115,6 +118,12 @@ func WithMaxHistorySize(size int64) BackendOption {
 	}
 }
 
+func WithWorkerName(workerName string) BackendOption {
+	return func(o *Options) {
+		o.WorkerName = workerName
+	}
+}
+
 func ApplyOptions(opts ...BackendOption) *Options {
 	options := DefaultOptions
 

backend/redis/queue.go

@@ -45,16 +45,25 @@ type KeyInfo struct {
 }
 
 func newTaskQueue[T any](ctx context.Context, rdb redis.UniversalClient, keyPrefix string, tasktype string) (*taskQueue[T], error) {
+	return newTaskQueueWithWorkerName[T](ctx, rdb, keyPrefix, tasktype, "")
+}
+
+func newTaskQueueWithWorkerName[T any](ctx context.Context, rdb redis.UniversalClient, keyPrefix string, tasktype string, workerName string) (*taskQueue[T], error) {
 	// Ensure the key prefix ends with a colon
 	if keyPrefix != "" && keyPrefix[len(keyPrefix)-1] != ':' {
 		keyPrefix += ":"
 	}
 
+	// Use provided worker name or generate UUID if empty
+	if workerName == "" {
+		workerName = uuid.NewString()
+	}
+
 	tq := &taskQueue[T]{
 		keyPrefix:   keyPrefix,
 		tasktype:    tasktype,
 		groupName:   "task-workers",
-		workerName:  uuid.NewString(),
+		workerName:  workerName,
 		queueSetKey: fmt.Sprintf("%s%s:queues", keyPrefix, tasktype),
 	}
 

backend/redis/redis.go

@@ -42,12 +42,12 @@ func NewRedisBackend(client redis.UniversalClient, opts ...RedisBackendOption) (
 
 	ctx := context.Background()
 
-	workflowQueue, err := newTaskQueue[workflowData](ctx, client, options.KeyPrefix, "workflows")
+	workflowQueue, err := newTaskQueueWithWorkerName[workflowData](ctx, client, options.KeyPrefix, "workflows", options.WorkerName)
 	if err != nil {
 		return nil, fmt.Errorf("creating workflow task queue: %w", err)
 	}
 
-	activityQueue, err := newTaskQueue[activityData](ctx, client, options.KeyPrefix, "activities")
+	activityQueue, err := newTaskQueueWithWorkerName[activityData](ctx, client, options.KeyPrefix, "activities", options.WorkerName)
 	if err != nil {
 		return nil, fmt.Errorf("creating activity task queue: %w", err)
 	}

backend/sqlite/options.go

@@ -9,21 +9,10 @@ type options struct {
 
 	// ApplyMigrations automatically applies database migrations on startup.
 	ApplyMigrations bool
-
-	// WorkerName allows setting a custom worker name. If not set, a random UUID will be generated.
-	WorkerName string
 }
 
 type option func(*options)
 
-// WithWorkerName sets a custom worker name for the SQLite backend.
-// If not provided, a random UUID will be generated.
-func WithWorkerName(workerName string) option {
-	return func(o *options) {
-		o.WorkerName = workerName
-	}
-}
-
 // WithApplyMigrations automatically applies database migrations on startup.
 func WithApplyMigrations(applyMigrations bool) option {
 	return func(o *options) {

backend/sqlite/sqlite.go

@@ -865,8 +865,8 @@ func (sb *sqliteBackend) ExtendActivityTask(ctx context.Context, task *backend.A
 
 // getWorkerName returns the worker name from options, or generates a UUID-based name if not set.
 func getWorkerName(options *options) string {
-	if options.WorkerName != "" {
-		return options.WorkerName
+	if options.Options.WorkerName != "" {
+		return options.Options.WorkerName
 	}
 	return fmt.Sprintf("worker-%v", uuid.NewString())
 }

backend/sqlite/sqlite_test.go

@@ -54,14 +54,14 @@ func Test_SqliteBackend_WorkerName(t *testing.T) {
 
 	t.Run("CustomWorkerName", func(t *testing.T) {
 		customWorkerName := "test-worker-123"
-		backend := NewInMemoryBackend(WithWorkerName(customWorkerName))
+		backend := NewInMemoryBackend(WithBackendOptions(backend.WithWorkerName(customWorkerName)))
 		defer backend.Close()
 
 		require.Equal(t, customWorkerName, backend.workerName)
 	})
 
 	t.Run("EmptyWorkerNameUsesDefault", func(t *testing.T) {
-		backend := NewInMemoryBackend(WithWorkerName(""))
+		backend := NewInMemoryBackend(WithBackendOptions(backend.WithWorkerName("")))
 		defer backend.Close()
 
 		// Empty worker name should fall back to UUID generation
@@ -71,7 +71,7 @@ func Test_SqliteBackend_WorkerName(t *testing.T) {
 
 	t.Run("CustomWorkerNameIsUsedInDatabase", func(t *testing.T) {
 		customWorkerName := "integration-test-worker"
-		backend := NewInMemoryBackend(WithWorkerName(customWorkerName))
+		backend := NewInMemoryBackend(WithBackendOptions(backend.WithWorkerName(customWorkerName)))
 		defer backend.Close()
 
 		// Verify the worker name is stored correctly