Clarify run ID may not be current in ResetWorkflowExecutionRequest #473
Conversation
| @@ -733,6 +733,9 @@ message SignalWithStartWorkflowExecutionResponse { | |||
|
|
|||
| message ResetWorkflowExecutionRequest { | |||
| string namespace = 1; | |||
| // The workflow ID and optional run ID to reset to. | |||
| // The current run will be terminated upon request even if it has a different run ID than the one provided in this | |||
There was a problem hiding this comment.
| // The current run will be terminated upon request even if it has a different run ID than the one provided in this | |
| // The current run will be terminated upon request if it has a different run ID than the one provided in this |
There was a problem hiding this comment.
I think this wording is important because in both cases the current run will be terminated.
There was a problem hiding this comment.
ah I see what you are saying. makes sense.
There was a problem hiding this comment.
Are we saying the following:
The provided
workflow_task_finish_event_idwill always be interpreted as addressing an event in the current workflow run, regardless of the presence or value of the run ID in the request?
There was a problem hiding this comment.
( moved this comment to apply to current code: https://github.com/temporalio/api/pull/473/files#r1834993098 )
bergundy
force-pushed
the
clarify-run-id-in-reset-request
branch
from
3dfb6bf to
fed0036
Compare
| @@ -733,6 +733,9 @@ message SignalWithStartWorkflowExecutionResponse { | |||
|
|
|||
| message ResetWorkflowExecutionRequest { | |||
| string namespace = 1; | |||
| // The workflow ID and optional run ID to reset to. | |||
| // The current run will be terminated even if it has a different run ID than the one provided in this | |||
| // request. | |||
There was a problem hiding this comment.
Presumably multiple runs might be terminated, if the request identifies a run far back in the chain?
Maybe some wording like the following?
The run identified by the request, and any subsequent runs, will be terminated by the reset, and a new run will be created that becomes the current run. If the request does not identify a run, then it is interpreted as identifying the current run.
There was a problem hiding this comment.
Presumably multiple runs might be terminated, if the request identifies a run far back in the chain?
No, there can only be one current run. Only the current one will be terminated.
There was a problem hiding this comment.
Let me know if that makes sense or you still want clarification.
There was a problem hiding this comment.
Haha yes, what I said made zero sense.
It's not a big problem but I'm still finding it slightly unclear. Here's another attempt:
// The workflow to reset. If this contains a run ID then the workflow will be reset back to the
// provided event ID in that run. Otherwise it will be reset to the provided event ID in the
// current run. In all cases the current run will be terminated and a new run started.
No description provided.