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

[Feature Request] Make startUpdate users aware that it's synchronous w/ worker #426

Closed
drewhoskins-temporal opened this issue Apr 25, 2024 · 1 comment · Fixed by #439
Closed
Labels
Documentation Improvements or additions to documentation enhancement
Milestone

Comments

@drewhoskins-temporal
Copy link

drewhoskins-temporal commented Apr 25, 2024

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

See temporalio/features#469

public function startUpdate(string|UpdateOptions $nameOrOptions, ...$args): UpdateHandle;

wait stage is currently optional and the docstring implies it's async rather than sync

Describe the solution you'd like

Additional context

@roxblnfk
Copy link
Collaborator

With the release of 2.9.0, the method description was adjusted in such a way that the user would not be misled about the asynchronous operation of the method (#429).

We decided to force customers to explicitly pass in a flag saying what’s being awaited. (e.g. start_update(wait_for_stage=ACCEPTED/COMPLETED)) and then if they don’t provide it.

However, changing the method signature will lead to a breaking change.
We can add a method like startUpdateAsync in the future when WaitPolicy support it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation enhancement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants