Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Require update handler to have a context #1457

Merged
merged 2 commits into from
May 9, 2024
Merged

Require update handler to have a context #1457

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c7bdae0
Require update handler to have a context
Quinn-With-Two-Ns May 8, 2024
9b8a67b
Fix unit test
Quinn-With-Two-Ns May 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions internal/internal_update.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,7 @@ func (up *updateProtocol) HasCompleted() bool {
//
// 1. is a function
// 2. has exactly one return parameter
// 3. the one return prarmeter is of type `error`
// 3. the one return parameter is of type `error`
func validateValidatorFn(fn interface{}) error {
fnType := reflect.TypeOf(fn)
if fnType.Kind() != reflect.Func {
Expand All @@ -405,13 +405,22 @@ func validateValidatorFn(fn interface{}) error {
// validateUpdateHandlerFn validates that the supplied interface
//
// 1. is a function
// 2. has one or two return parameters, the last of which is of type `error`
// 3. if there are two return parameters, the first is a serializable type
// 2. has at least one parameter, the first of which is of type `workflow.Context`
// 3. has one or two return parameters, the last of which is of type `error`
// 4. if there are two return parameters, the first is a serializable type
func validateUpdateHandlerFn(fn interface{}) error {
fnType := reflect.TypeOf(fn)
if fnType.Kind() != reflect.Func {
return fmt.Errorf("handler must be function but was %s", fnType.Kind())
}
if fnType.NumIn() == 0 {
return errors.New("first parameter of handler must be a workflow.Context")
} else if !isWorkflowContext(fnType.In(0)) {
return fmt.Errorf(
"first parameter of handler must be a workflow.Context but found %v",
fnType.In(0).Kind(),
)
}
switch fnType.NumOut() {
case 1:
if !isError(fnType.Out(0)) {
Expand Down
14 changes: 8 additions & 6 deletions internal/internal_update_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ func TestUpdateHandlerPanicHandling(t *testing.T) {
interceptor, ctx, err := newWorkflowContext(env, nil)
require.NoError(t, err)

panicFunc := func() error { panic("intentional") }
panicFunc := func(ctx Context) error { panic("intentional") }
dispatcher, _ := newDispatcher(
ctx,
interceptor,
Expand All @@ -123,7 +123,7 @@ func TestUpdateHandlerPanicHandling(t *testing.T) {
interceptor, ctx, err := newWorkflowContext(env, nil)
require.NoError(t, err)

panicFunc := func() error { panic("intentional") }
panicFunc := func(ctx Context) error { panic("intentional") }
dispatcher, _ := newDispatcher(
ctx,
interceptor,
Expand Down Expand Up @@ -151,10 +151,12 @@ func TestUpdateHandlerFnValidation(t *testing.T) {
{require.Error, func() int { return 0 }},
{require.Error, func(Context, int) (int, int, error) { return 0, 0, nil }},
{require.Error, func(int) (chan int, error) { return nil, nil }},
{require.NoError, func() error { return nil }},
{require.Error, func() error { return nil }},
{require.Error, func(int, int, string) error { return nil }},
{require.Error, func(int) error { return nil }},
{require.NoError, func(Context, int) error { return nil }},
{require.NoError, func(Context, int, int, string) error { return nil }},
{require.NoError, func(Context) error { return nil }},
{require.NoError, func(int) error { return nil }},
{require.NoError, func(int, int, string) error { return nil }},
{require.NoError, func(Context, int, int, string) error { return nil }},
} {
t.Run(reflect.TypeOf(tc.fn).String(), func(t *testing.T) {
Expand Down Expand Up @@ -219,7 +221,7 @@ func TestDefaultUpdateHandler(t *testing.T) {
t,
ctx,
"unused_handler",
func() error { panic("should not be called") },
func(ctx Context) error { panic("should not be called") },
UpdateHandlerOptions{},
)
},
Expand Down
Loading