Update-with-Start returns closed workflow's Outcome #7656
Merged
Conversation
This file contains hidden or 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
baa817e to
f6062ca
Compare
f6062ca to
5a6112c
Compare
stephanos
commented
Apr 25, 2025
| &historyservice.StartWorkflowExecutionResponse{ | ||
| RunId: workflowKey.RunID, | ||
| Started: false, // set explicitly for emphasis | ||
| // TODO: Running: false, |
There was a problem hiding this comment.
This requires an API change.
There was a problem hiding this comment.
I guess you need to rename it to status here too but as soon as it is just a comment it doesn't really matter.
There was a problem hiding this comment.
👍 I'll save the planet by not pushing the comment update now; and will fix it in the next PR.
stephanos
commented
Apr 25, 2025
| return runningWorkflowLease, nil | ||
| } | ||
|
|
||
| func (mo *multiOp) allowUpdateWorkflow( | ||
| ctx context.Context, |
5a6112c to
8a7be4d
Compare
alexshtin
approved these changes
Apr 29, 2025
| s.NoError(uwsRes.err) | ||
| startResp := uwsRes.response.Responses[0].GetStartWorkflow() | ||
| updateRep := uwsRes.response.Responses[1].GetUpdateWorkflow() | ||
| s.False(startResp.Started) |
There was a problem hiding this comment.
Don't forget to assert on new status field here after you add it.
| &historyservice.StartWorkflowExecutionResponse{ | ||
| RunId: workflowKey.RunID, | ||
| Started: false, // set explicitly for emphasis | ||
| // TODO: Running: false, |
There was a problem hiding this comment.
I guess you need to rename it to status here too but as soon as it is just a comment it doesn't really matter.
stephanos
added a commit
to temporalio/api
that referenced
this pull request
May 1, 2025
_**READ BEFORE MERGING:** All PRs require approval by both Server AND SDK teams before merging! This is why the number of required approvals is "2" and not "1"--two reviewers from the same team is NOT sufficient. If your PR is not approved by someone in BOTH teams, it may be summarily reverted._ <!-- Describe what has changed in this PR --> **What changed?** Added field `WorkflowExecutionStatus status` to `StartWorkflowExecutionResponse`. <!-- Tell your future self why have you made these changes --> **Why?** To align Update-with-Start's behavior with a regular Update. A regular Update returns its outcome from a closed Workflow, to make Update-with-Start do the same thing, it needs to returns a successful response in that case. But that would tell the user that a running Workflow exists. To help the user distinguish whether UwS operated on a closed or running workflow, this field is introduced. <!-- Are there any breaking changes on binary or code level? --> **Breaking changes** No. <!-- If this breaks the Server, please provide the Server PR to merge right after this PR was merged. --> **Server PR** temporalio/temporal#7656
temporal-cicd bot
pushed a commit
to temporalio/api-go
that referenced
this pull request
May 1, 2025
_**READ BEFORE MERGING:** All PRs require approval by both Server AND SDK teams before merging! This is why the number of required approvals is "2" and not "1"--two reviewers from the same team is NOT sufficient. If your PR is not approved by someone in BOTH teams, it may be summarily reverted._ <!-- Describe what has changed in this PR --> **What changed?** Added field `WorkflowExecutionStatus status` to `StartWorkflowExecutionResponse`. <!-- Tell your future self why have you made these changes --> **Why?** To align Update-with-Start's behavior with a regular Update. A regular Update returns its outcome from a closed Workflow, to make Update-with-Start do the same thing, it needs to returns a successful response in that case. But that would tell the user that a running Workflow exists. To help the user distinguish whether UwS operated on a closed or running workflow, this field is introduced. <!-- Are there any breaking changes on binary or code level? --> **Breaking changes** No. <!-- If this breaks the Server, please provide the Server PR to merge right after this PR was merged. --> **Server PR** temporalio/temporal#7656
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.
StartWorkflowExecutionResponseAPI needs to have a new fieldRunningadded to it.What changed?
When UwS is applied to a closes Workflow where the requested Update (identified by its Update ID) has already been completed, return the Update outcome.
Note that this only applies to the current execution; not any previous execution.
Why?
Align UwS behavior with Update; a regular Update also returns its outcome from a closed Workflow.
How did you test it?
New tests.
Potential risks
Documentation
Is hotfix candidate?