Skip to content

Add warning when registering struct functions as workflows #1996

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

Closed
yuandrew wants to merge 4 commits into from
Closed

Add warning when registering struct functions as workflows #1996

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4fa5051
Add warning for defining struct
yuandrew Jul 8, 2025
575b486
warn on -fm, not on WorkflowDefinitionFactory
yuandrew Jul 10, 2025
61173fd
Add function name to warning log
yuandrew Jul 10, 2025
3b0b595
Don't abbreviate NDE
yuandrew Jul 10, 2025
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
4 changes: 4 additions & 0 deletions internal/internal_worker.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1147,6 +1147,10 @@ func (aw *AggregatedWorker) RegisterWorkflow(w interface{}) {
aw.executionParams.DefaultVersioningBehavior == VersioningBehaviorUnspecified {
panic("workflow type does not have a versioning behavior")
}
fnName := runtime.FuncForPC(reflect.ValueOf(w).Pointer()).Name()
if strings.HasSuffix(fnName, "-fm") {
aw.logger.Warn("Registering workflow" + fnName + ". It is recommended to only use struct methods to define activity functions. In some cases, struct methods as workflows may cause NDE errors.")
Copy link
Copy Markdown
Contributor

@cretz cretz Jul 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pedantic, but would avoid the acronym NDE in user-facing contexts

Copy link
Copy Markdown
Contributor Author

@yuandrew yuandrew Jul 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the suggestion :)

}
aw.registry.RegisterWorkflow(w)
}

Expand Down
Loading