Document ambiguous ID and test for mismatch on signal start #612
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
cretz
requested review from
alexshtin,
bergundy,
mfateev,
Spikhalskiy,
Sushisource and
vitarb
as code owners
cretz
changed the title
bergundy
reviewed
Nov 2, 2021
| // Due to the ambiguous way to provide workflow IDs, if options contains an | ||
| // ID, it must match the parameter | ||
| if options.ID != "" && options.ID != workflowID { | ||
| return nil, fmt.Errorf("workflow ID from options not used, must be unset or match workflow ID parameter") |
There was a problem hiding this comment.
This is technically a breaking change.
I think it's necessary but we should document this in the release notes and mark it as breaking.
There was a problem hiding this comment.
It's only a breaking change if you consider extra validation of (unbeknownst) improper param setting as a breaking change. It went from being an invalid param do the wrong thing to an invalid param error.
There was a problem hiding this comment.
I'm aware, but this still could result in a change of behavior in some rare cases.
There was a problem hiding this comment.
👍 Ok, I will make sure to document in the release notes
bergundy
approved these changes
Nov 2, 2021
…orkflow-id # Conflicts: # internal/internal_workflow_client.go # internal/internal_workflow_client_test.go
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
Document different ways to give workflow ID on signal with start, and ensure the unused one doesn't mismatch.
Why?
We ignore workflow IDs coming from options, so we make sure it's not expecting to be used.
Checklist
SignalWithStartWorkflowdoes not use same workflow ID option asExecuteWorkflow#603