Merge pull request #193 from cschleiden/register-by-name

Allow registering workflows and activities by name

Author: cschleiden

internal/workflow/registry.go

@@ -42,10 +42,7 @@ func (e *ErrInvalidActivity) Error() string {
 	return e.msg
 }
 
-func (r *Registry) RegisterWorkflow(workflow Workflow) error {
-	r.Lock()
-	defer r.Unlock()
-
+func (r *Registry) RegisterWorkflowByName(name string, workflow Workflow) error {
 	wfType := reflect.TypeOf(workflow)
 	if wfType.Kind() != reflect.Func {
 		return &ErrInvalidWorkflow{"workflow is not a function"}
@@ -73,16 +70,20 @@ func (r *Registry) RegisterWorkflow(workflow Workflow) error {
 		return &ErrInvalidWorkflow{"workflow must return error as last return value"}
 	}
 
-	name := fn.Name(workflow)
+	r.Lock()
+	defer r.Unlock()
+
 	r.workflowMap[name] = workflow
 
 	return nil
 }
 
-func (r *Registry) RegisterActivity(activity interface{}) error {
-	r.Lock()
-	defer r.Unlock()
+func (r *Registry) RegisterWorkflow(workflow Workflow) error {
+	name := fn.Name(workflow)
+	return r.RegisterWorkflowByName(name, workflow)
+}
 
+func (r *Registry) RegisterActivityByName(name string, activity interface{}) error {
 	t := reflect.TypeOf(activity)
 
 	// Activities on struct
@@ -95,12 +96,19 @@ func (r *Registry) RegisterActivity(activity interface{}) error {
 		return err
 	}
 
-	name := fn.Name(activity)
+	r.Lock()
+	defer r.Unlock()
+
 	r.activityMap[name] = activity
 
 	return nil
 }
 
+func (r *Registry) RegisterActivity(activity interface{}) error {
+	name := fn.Name(activity)
+	return r.RegisterActivityByName(name, activity)
+}
+
 func (r *Registry) registerActivitiesFromStruct(a interface{}) error {
 	// Enumerate functions defined on a
 	v := reflect.ValueOf(a)

internal/workflow/registry_test.go

@@ -15,6 +15,7 @@ func reg_workflow1(ctx sync.Context) error {
 
 func TestRegistry_RegisterWorkflow(t *testing.T) {
 	type args struct {
+		name     string
 		workflow Workflow
 	}
 	tests := []struct {
@@ -30,6 +31,14 @@ func TestRegistry_RegisterWorkflow(t *testing.T) {
 			},
 			wantName: "reg_workflow1",
 		},
+		{
+			name: "valid workflow by name",
+			args: args{
+				name:     "CustomName",
+				workflow: reg_workflow1,
+			},
+			wantName: "CustomName",
+		},
 		{
 			name: "valid workflow with results",
 			args: args{
@@ -74,7 +83,15 @@ func TestRegistry_RegisterWorkflow(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			r := NewRegistry()
-			if err := r.RegisterWorkflow(tt.args.workflow); (err != nil) != tt.wantErr {
+			var err error
+
+			if tt.args.name != "" {
+				err = r.RegisterWorkflowByName(tt.args.name, tt.args.workflow)
+			} else {
+				err = r.RegisterWorkflow(tt.args.workflow)
+			}
+
+			if (err != nil) != tt.wantErr {
 				t.Errorf("Registry.RegisterWorkflow() error = %v, wantErr %v", err, tt.wantErr)
 				t.FailNow()
 			}
@@ -108,6 +125,12 @@ func Test_ActivityRegistration(t *testing.T) {
 
 	err = fn(context.Background())
 	require.NoError(t, err)
+
+	err = r.RegisterActivityByName("CustomName", reg_activity)
+	require.NoError(t, err)
+
+	x, err = r.GetActivity("CustomName")
+	require.NoError(t, err)
 }
 
 func reg_activity_invalid(ctx context.Context) {

tester/tester.go

@@ -79,9 +79,13 @@ type WorkflowTester[TResult any] interface {
 
 	Registry() *workflow.Registry
 
-	OnActivity(activity interface{}, args ...interface{}) *mock.Call
+	OnActivity(activity workflow.Activity, args ...interface{}) *mock.Call
 
-	OnSubWorkflow(workflow interface{}, args ...interface{}) *mock.Call
+	OnActivityByName(name string, activity workflow.Activity, args ...interface{}) *mock.Call
+
+	OnSubWorkflow(workflow workflow.Workflow, args ...interface{}) *mock.Call
+
+	OnSubWorkflowByName(name string, workflow workflow.Workflow, args ...interface{}) *mock.Call
 
 	SignalWorkflow(signalName string, value interface{})
 
@@ -238,7 +242,15 @@ func (wt *workflowTester[TResult]) ListenSubWorkflow(listener func(*core.Workflo
 	wt.subWorkflowListener = listener
 }
 
-func (wt *workflowTester[TResult]) OnActivity(activity interface{}, args ...interface{}) *mock.Call {
+func (wt *workflowTester[TResult]) OnActivityByName(name string, activity workflow.Activity, args ...interface{}) *mock.Call {
+	// Register activity so that we can correctly identify its arguments later
+	wt.registry.RegisterActivityByName(name, activity)
+
+	wt.mockedActivities[name] = true
+	return wt.ma.On(name, args...)
+}
+
+func (wt *workflowTester[TResult]) OnActivity(activity workflow.Activity, args ...interface{}) *mock.Call {
 	// Register activity so that we can correctly identify its arguments later
 	wt.registry.RegisterActivity(activity)
 
@@ -247,7 +259,15 @@ func (wt *workflowTester[TResult]) OnActivity(activity interface{}, args ...inte
 	return wt.ma.On(name, args...)
 }
 
-func (wt *workflowTester[TResult]) OnSubWorkflow(workflow interface{}, args ...interface{}) *mock.Call {
+func (wt *workflowTester[TResult]) OnSubWorkflowByName(name string, workflow workflow.Workflow, args ...interface{}) *mock.Call {
+	// Register workflow so that we can correctly identify its arguments later
+	wt.registry.RegisterWorkflowByName(name, workflow)
+
+	wt.mockedWorkflows[name] = true
+	return wt.mw.On(name, args...)
+}
+
+func (wt *workflowTester[TResult]) OnSubWorkflow(workflow workflow.Workflow, args ...interface{}) *mock.Call {
 	// Register workflow so that we can correctly identify its arguments later
 	wt.registry.RegisterWorkflow(workflow)
 

tester/tester_test.go

@@ -56,6 +56,19 @@ func Test_Activity(t *testing.T) {
 	tester.AssertExpectations(t)
 }
 
+func Test_OverrideActivity(t *testing.T) {
+	tester := NewWorkflowTester[int](workflowWithActivity)
+
+	tester.OnActivityByName("activity1", activity1, mock.Anything).Return(23, nil)
+
+	tester.Execute()
+
+	require.True(t, tester.WorkflowFinished())
+	wr, _ := tester.WorkflowResult()
+	require.Equal(t, 23, wr)
+	tester.AssertExpectations(t)
+}
+
 func Test_FailingActivity(t *testing.T) {
 	tester := NewWorkflowTester[int](workflowWithActivity)