Workflow update client API refactor #1489
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
Quinn-With-Two-Ns
changed the title
cretz
reviewed
May 24, 2024
client/client.go
Outdated
| // directly from this function call. | ||
| // NOTE: Experimental | ||
| UpdateWorkflowWithOptions(ctx context.Context, request *UpdateWorkflowWithOptionsRequest) (WorkflowUpdateHandle, error) | ||
| UpdateWorkflow(ctx context.Context, request *UpdateWorkflowOptionsRequest) (WorkflowUpdateHandle, error) |
There was a problem hiding this comment.
Suggested change
| UpdateWorkflow(ctx context.Context, request *UpdateWorkflowOptionsRequest) (WorkflowUpdateHandle, error) | |
| UpdateWorkflow(ctx context.Context, options UpdateWorkflowOptions) (WorkflowUpdateHandle, error) |
Wonder if it is a "request" or "options", and since it will always be required, probably not value in accepting a pointer (I know we are inconsistent here). Even if it is a "request", then can probably remove the word "Options" from within. I don't have strong opinions here.
There was a problem hiding this comment.
Yeah i think we used request since that is what QueryWorkflowWithOptions did. I can change it to not take a pointer.
There was a problem hiding this comment.
👍 I can see arguments for both Request and Options for the value of X in UpdateWorkflowX, but probably don't need both. (I have no strong opinion on which, I kinda like "options" but it's a very weak preference, your choice)
cretz
approved these changes
May 24, 2024
Quinn-With-Two-Ns
force-pushed
the
update-refactor
branch
from
d0ad60c to
d7bedd7
Compare
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.
This PR makes multiple changes to the client experience around update:
UpdateWorkflowWithOptionsandUpdateWorkflowto a single apiWaitForStagea required parameter in updatecloses #1414
closes #1449
closes #1411
since this has multiple breaking changes feature tests are expected to fail until I make a separate branch