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.

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

Clarify waiting semantics for UpdateWorkflow #1449

Closed
drewhoskins-temporal opened this issue Apr 25, 2024 · 0 comments · Fixed by #1489
Closed

Clarify waiting semantics for UpdateWorkflow #1449

drewhoskins-temporal opened this issue Apr 25, 2024 · 0 comments · Fixed by #1489
Labels
enhancement New feature or request

Comments

@drewhoskins-temporal
Copy link

drewhoskins-temporal commented Apr 25, 2024

Is your feature request related to a problem? Please describe.
Per

sdk-go/client/client.go

Lines 575 to 586 in 8361067

UpdateWorkflow(ctx context.Context, workflowID string, workflowRunID string, updateName string, args ...interface{}) (WorkflowUpdateHandle, error)
// UpdateWorkflowWithOptions issues an update request to the
// specified workflow execution and returns a handle to the update that
// is running in in parallel with the calling thread. Errors returned
// from the server will be exposed through the return value of
// WorkflowUpdateHandle.Get(). Errors that occur before the
// update is requested (e.g. if the required workflow ID field is
// missing from the UpdateWorkflowWithOptionsRequest) are returned
// directly from this function call.
// NOTE: Experimental
UpdateWorkflowWithOptions(ctx context.Context, request *UpdateWorkflowWithOptionsRequest) (WorkflowUpdateHandle, error)

it's unclear from the docstrings how to start a workflow and wait for acceptance/rejection.
I see https://github.com/temporalio/sdk-go/blob/master/internal/internal_workflow_client.go#L756 and, per the parent task, want to make sure we require WaitPolicy and don't default to anything that could be dangerous.

Describe the solution you'd like
Make sure availability tradeoff is documented clearly and user is opting in to a wait policy.

Describe alternatives you've considered

Additional context
Add any other context or screenshots about the feature request here.
Parent: temporalio/features#469

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant