Add link field to propagate backlink in signal and signal-with-start responses#761
Conversation
long-nt-tran
force-pushed
the
signals-backlink-api
branch
from
7abc353 to
5c99d1b
Compare
| // Link to be associated with the WorkflowExecutionSignaled event. | ||
| // Added on the response to propagate the backlink. | ||
| temporal.api.common.v1.Link signal_link = 3; | ||
| // Workflow start link to be associated with the WorkflowExecutionStarted event. |
There was a problem hiding this comment.
Would this be propagated back to the caller if the workflow was already started? Seems like that would be confusing. I would call out the behavior in the docstring.
There was a problem hiding this comment.
IMO it should behave like the workflow event link on a normal start workflow, so link to the start if the workflow is started, link to the workflow options update if a callback was attached after the workflow was started.
There was a problem hiding this comment.
commenting for posterity: chatted w/ both offline and we decided to add this in a later PR
long-nt-tran
force-pushed
the
signals-backlink-api
branch
from
5c99d1b to
168fcbb
Compare
bergundy
left a comment
bergundy
left a comment
There was a problem hiding this comment.
Approved with a small comment.
long-nt-tran
force-pushed
the
signals-backlink-api
branch
from
168fcbb to
c7d4e90
Compare
long-nt-tran
force-pushed
the
signals-backlink-api
branch
from
c7d4e90 to
99f97eb
Compare
long-nt-tran
force-pushed
the
signals-backlink-api
branch
from
99f97eb to
7111b0b
Compare
| // The request ID of the Signal request, used by the server to attach this to | ||
| // the correct Event ID when generating link. | ||
| string request_id = 7; |
There was a problem hiding this comment.
commenting for posterity: discussed offline w/ server, this change (post-server-approval) is ok, see this comment for more details
4 participants
What changed?
Added
linkfields onSignalWorkflowExecutionResponseandSignalWithStartWorkflowExecutionRequest. I think a singular link should suffice but if reviewers feel otherwise (especially w.r.t.SignalWithStartWorkflowExecutionRequest) let me know.Why?
To propagate backlinks on signal and signal-with-start executions back to the caller.
Breaking changes
Not a breaking change (unused field)
Server PR
temporalio/temporal#9897