-
Notifications
You must be signed in to change notification settings - Fork 42
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
Expose Workflow Updates #398
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
and relater responses
Sushisource
reviewed
Feb 15, 2024
Sushisource
approved these changes
Feb 16, 2024
wolfy-j
approved these changes
Feb 28, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What was changed
Exposed Update functionality.
Added attributes:
RoadRunner requirement ^2023.3.11
Note
Temporal tes-server doesn't support Updates. That's why the tests was skipped in CI
Checklist
TODO:
Documentation
How to develop with Updates
An Update is an operation that can mutate the state of a Workflow Execution and return a response.
How to define Updates
An Update handler has a name, arguments, response, and an optional validator.
The
#[UpdateMethod]
attribute indicates that the method is used to handle and respond to update requests.How to handle Updates in a Workflow
Workflows listen for Update by the update's name.
The handler method can accept multiple serializable input parameters, but it's recommended using only a single parameter.
The function can return a serializable value or
void
.Update handlers, unlike Query handlers, can change Workflow state.
The Updates type defaults to the name of the method. To overwrite this default naming and assign a custom Update type, use the
#[UpdateMethod]
attribute with thename
parameter.How to validate an Update in a Workflow
Validate certain aspects of the data sent to the Workflow using an Update Validator method. For instance, a counter Workflow might never want to accept a non-positive number. Use the
#[UpdateValidatorMethod]
attribute and setname
to the name of your Update handler. Your Update Validator should accept the same input parameters as your Update Handler and returnvoid
.How to send an Update from a Client
To send an Update to a Workflow Execution from a Client, call the Update method, annotated with
#[UpdateMethod]
in the Workflow interface, from the Client code.In the following Client code example, start the Workflow
getGreetings
and call the Update methodaddGreeting
that is handled in the Workflow.