Merge pull request #387 from cschleiden/copilot/fix-386

Allow setting custom worker names for SQL backends

Author: cschleiden

backend/mysql/mysql.go

@@ -55,7 +55,7 @@ func NewMysqlBackend(host string, port int, user, password, database string, opt
 	b := &mysqlBackend{
 		dsn:        dsn,
 		db:         db,
-		workerName: fmt.Sprintf("worker-%v", uuid.NewString()),
+		workerName: getWorkerName(options),
 		options:    options,
 	}
 
@@ -974,3 +974,11 @@ func scheduleActivity(ctx context.Context, tx *sql.Tx, queue workflow.Queue, ins
 
 	return err
 }
+
+// getWorkerName returns the worker name from options, or generates a UUID-based name if not set.
+func getWorkerName(options *options) string {
+	if options.Options.WorkerName != "" {
+		return options.Options.WorkerName
+	}
+	return fmt.Sprintf("worker-%v", uuid.NewString())
+}

backend/mysql/mysql_test.go

@@ -162,3 +162,53 @@ func (mb *mysqlBackend) GetFutureEvents(ctx context.Context) ([]*history.Event,
 
 	return f, nil
 }
+
+func Test_MysqlBackend_WorkerName(t *testing.T) {
+	if testing.Short() {
+		t.Skip()
+	}
+
+	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: backend.ApplyOptions(),
+		}
+		workerName := getWorkerName(options)
+
+		// The default worker name should be in the format "worker-<uuid>"
+		if !strings.Contains(workerName, "worker-") {
+			t.Errorf("Expected worker name to contain 'worker-', got: %s", workerName)
+		}
+		if len(workerName) != 43 { // "worker-" (7) + UUID (36)
+			t.Errorf("Expected worker name length to be 43, got: %d", len(workerName))
+		}
+	})
+
+	t.Run("CustomWorkerName", func(t *testing.T) {
+		customWorkerName := "test-worker-123"
+		options := &options{
+			Options: backend.ApplyOptions(backend.WithWorkerName(customWorkerName)),
+		}
+		workerName := getWorkerName(options)
+
+		if workerName != customWorkerName {
+			t.Errorf("Expected worker name to be '%s', got: %s", customWorkerName, workerName)
+		}
+	})
+
+	t.Run("EmptyWorkerNameUsesDefault", func(t *testing.T) {
+		options := &options{
+			Options: backend.ApplyOptions(backend.WithWorkerName("")),
+		}
+		workerName := getWorkerName(options)
+
+		// Empty worker name should fall back to UUID generation
+		if !strings.Contains(workerName, "worker-") {
+			t.Errorf("Expected worker name to contain 'worker-', got: %s", workerName)
+		}
+		if len(workerName) != 43 { // "worker-" (7) + UUID (36)
+			t.Errorf("Expected worker name length to be 43, got: %d", len(workerName))
+		}
+	})
+}

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

@@ -44,17 +44,22 @@ type KeyInfo struct {
 	SetKey    string
 }
 
-func newTaskQueue[T any](ctx context.Context, rdb redis.UniversalClient, keyPrefix string, tasktype string) (*taskQueue[T], error) {
+func newTaskQueue[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/queue_test.go

@@ -106,7 +106,7 @@ func Test_TaskQueue(t *testing.T) {
 
 				ctx := context.Background()
 
-				q, err := newTaskQueue[foo](context.Background(), client, "prefix", taskType)
+				q, err := newTaskQueue[foo](context.Background(), client, "prefix", taskType, "")
 				require.NoError(t, err)
 
 				_, err = client.Pipelined(ctx, func(p redis.Pipeliner) error {
@@ -135,7 +135,7 @@ func Test_TaskQueue(t *testing.T) {
 				})
 				require.NoError(t, err)
 
-				q2, _ := newTaskQueue[any](context.Background(), client, "prefix", taskType)
+				q2, _ := newTaskQueue[any](context.Background(), client, "prefix", taskType, "")
 				require.NoError(t, err)
 
 				// Dequeue using second worker
@@ -148,7 +148,7 @@ func Test_TaskQueue(t *testing.T) {
 		{
 			name: "Complete removes task",
 			f: func(t *testing.T, q *taskQueue[any]) {
-				q2, _ := newTaskQueue[any](context.Background(), client, "prefix", taskType)
+				q2, _ := newTaskQueue[any](context.Background(), client, "prefix", taskType, "")
 
 				ctx := context.Background()
 
@@ -182,7 +182,7 @@ func Test_TaskQueue(t *testing.T) {
 				type taskData struct {
 					Count int `json:"count"`
 				}
-				q, _ := newTaskQueue[taskData](context.Background(), client, "prefix", taskType)
+				q, _ := newTaskQueue[taskData](context.Background(), client, "prefix", taskType, "")
 
 				ctx := context.Background()
 
@@ -193,7 +193,7 @@ func Test_TaskQueue(t *testing.T) {
 				})
 				require.NoError(t, err)
 
-				q2, _ := newTaskQueue[taskData](context.Background(), client, "prefix", taskType)
+				q2, _ := newTaskQueue[taskData](context.Background(), client, "prefix", taskType, "")
 				require.NoError(t, err)
 
 				task, err := q2.Dequeue(ctx, client, []workflow.Queue{workflow.QueueDefault}, lockTimeout, blockTimeout)
@@ -221,7 +221,7 @@ func Test_TaskQueue(t *testing.T) {
 				require.NoError(t, err)
 
 				// Create second worker (with different name)
-				q2, _ := newTaskQueue[any](context.Background(), client, "prefix", taskType)
+				q2, _ := newTaskQueue[any](context.Background(), client, "prefix", taskType, "")
 				require.NoError(t, err)
 
 				task, err := q2.Dequeue(ctx, client, []workflow.Queue{workflow.QueueDefault}, lockTimeout, blockTimeout)
@@ -281,7 +281,7 @@ func Test_TaskQueue(t *testing.T) {
 
 			ctx := context.Background()
 
-			q, err := newTaskQueue[any](ctx, client, "prefix", taskType)
+			q, err := newTaskQueue[any](ctx, client, "prefix", taskType, "")
 			require.NoError(t, err)
 
 			q.Prepare(ctx, client, []workflow.Queue{workflow.QueueDefault})

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 := newTaskQueue[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 := newTaskQueue[activityData](ctx, client, options.KeyPrefix, "activities", options.WorkerName)
 	if err != nil {
 		return nil, fmt.Errorf("creating activity task queue: %w", err)
 	}

backend/sqlite/sqlite.go

@@ -76,7 +76,7 @@ func newSqliteBackend(dsn string, opts ...option) *sqliteBackend {
 
 	b := &sqliteBackend{
 		db:         db,
-		workerName: fmt.Sprintf("worker-%v", uuid.NewString()),
+		workerName: getWorkerName(options),
 		options:    options,
 	}
 
@@ -862,3 +862,11 @@ func (sb *sqliteBackend) ExtendActivityTask(ctx context.Context, task *backend.A
 
 	return tx.Commit()
 }
+
+// getWorkerName returns the worker name from options, or generates a UUID-based name if not set.
+func getWorkerName(options *options) string {
+	if options.Options.WorkerName != "" {
+		return options.Options.WorkerName
+	}
+	return fmt.Sprintf("worker-%v", uuid.NewString())
+}

backend/sqlite/sqlite_test.go

@@ -36,3 +36,40 @@ func Test_EndToEndSqliteBackend(t *testing.T) {
 		require.NoError(t, b.Close())
 	})
 }
+
+func Test_SqliteBackend_WorkerName(t *testing.T) {
+	t.Run("DefaultWorkerName", func(t *testing.T) {
+		backend := NewInMemoryBackend()
+		defer backend.Close()
+
+		// The default worker name should be in the format "worker-<uuid>"
+		require.Contains(t, backend.workerName, "worker-")
+		require.Len(t, backend.workerName, 43) // "worker-" (7) + UUID (36)
+	})
+
+	t.Run("CustomWorkerName", func(t *testing.T) {
+		customWorkerName := "test-worker-123"
+		backend := NewInMemoryBackend(WithBackendOptions(backend.WithWorkerName(customWorkerName)))
+		defer backend.Close()
+
+		require.Equal(t, customWorkerName, backend.workerName)
+	})
+
+	t.Run("EmptyWorkerNameUsesDefault", func(t *testing.T) {
+		backend := NewInMemoryBackend(WithBackendOptions(backend.WithWorkerName("")))
+		defer backend.Close()
+
+		// Empty worker name should fall back to UUID generation
+		require.Contains(t, backend.workerName, "worker-")
+		require.Len(t, backend.workerName, 43) // "worker-" (7) + UUID (36)
+	})
+
+	t.Run("CustomWorkerNameIsUsedInDatabase", func(t *testing.T) {
+		customWorkerName := "integration-test-worker"
+		backend := NewInMemoryBackend(WithBackendOptions(backend.WithWorkerName(customWorkerName)))
+		defer backend.Close()
+
+		// Verify the worker name is stored correctly
+		require.Equal(t, customWorkerName, backend.workerName)
+	})
+}