Set Nexus operation ID on callback headers #1710

pdoerner · 2024-11-15T06:54:19Z

What was changed

Setting nexus-operation-id header on callback headers.
Depends on nexus-rpc/sdk-go#26
Returns an error is the workflow ID is unset on the start options for a Nexus operation

Why?

This information is necessary for fabricating a NexusOperationStarted event if the completion is received before the response to a StartOperation request. This ID is set to the workflow ID unless the user provides a value for this header; user-provided values for this header are not overwritten.

Checklist

Closes
How was this tested:

Existing tests

Any docs updates needed?

bergundy

LGTM.

Another non-blocking request is to always have the server generate the links (SDK can generate as a fallback when used with an old server).
That way operation ID is always coming from the SDK and the link from the server.

We should also document the implications of changing the operation ID returned from WorkflowRunOperation.Start. Let's tell them to never do that because the ID is used for cancelation and is reporting completion from the server.

bergundy · 2024-11-15T22:13:55Z

temporalnexus/operation.go

@@ -324,12 +325,21 @@ func ExecuteUntypedWorkflow[R any](
 	if startWorkflowOptions.TaskQueue == "" {
 		startWorkflowOptions.TaskQueue = nctx.TaskQueue
 	}
+	if startWorkflowOptions.ID == "" {


I'm wondering if we want to require setting workflow ID for Nexus operations. We require it in all Core based SDKs, maybe we can at least protect Nexus users. Not blocking this PR though. @cretz, @Quinn-With-Two-Ns to weigh in on this.

I thought the Go SDK did require setting a workflow ID for Nexus operations? I think it makes sense to require it or at least default it to something deterministic so starting a workflow is idempotent

Yes, this was my intent but I think the client will automatically fill in an ID unless one is provided. Need to verify this.

We require it meaning I don't need the check for it being empty here? I looked for where a default would be set but didn't find anything that would set it before this point.

I would change to ensure that the client doesn't auto generate an ID if one isn't set.

We should note this change in the release notes. I would consider it a backwards incompatible behavior change.

if startWorkflowOptions.ID == "" { return nil, ErrMissingWorkflowID }

@pdoerner this already changed for Java, please make sure to disallow empty workflow ID for nexus ops before merging this.

pdoerner · 2024-11-19T18:46:50Z

@bergundy re this comment

Another non-blocking request is to always have the server generate the links (SDK can generate as a fallback when used with an old server). That way operation ID is always coming from the SDK and the link from the server.

I didn't add any generation for links here; are you suggesting I should add the fallback?

bergundy

Please change the behavior when there's a missing workflow ID.

bergundy · 2024-11-21T00:23:13Z

@bergundy re this comment

Another non-blocking request is to always have the server generate the links (SDK can generate as a fallback when used with an old server). That way operation ID is always coming from the SDK and the link from the server.

I didn't add any generation for links here; are you suggesting I should add the fallback?

I'm saying we modify the server to return links and only generate them in the SDK in if the server doesn't return them in the StartWorkflowExecutionResponse. We'll need to consider when to return these links though. I opened an issue to track this, it's not blocking.

Quinn-With-Two-Ns · 2024-11-27T17:17:38Z

internal/error.go

@@ -338,6 +338,9 @@ var (

 	// ErrSkipScheduleUpdate is used by a user if they want to skip updating a schedule.
 	ErrSkipScheduleUpdate = errors.New("skip schedule update")
+
+	// ErrMissingWorkflowID is returned when trying to start an async Nexus operation but no workflow ID is set on the request.
+	ErrMissingWorkflowID = errors.New("workflow ID is unset")


nit can the error message make it clear that it was unset for a Nexus operation

Quinn-With-Two-Ns · 2024-11-27T17:46:09Z

temporalnexus/operation.go

+		if nexusOptions.CallbackHeader == nil {
+			nexusOptions.CallbackHeader = make(nexus.Header)
+		}
+		if _, set := nexusOptions.CallbackHeader[nexus.HeaderOperationID]; !set {


nit: should we use the case insensitive operations on the headers? I guess nexus.HeaderOperationID is now lower case so it isn't that important.

## What changed?  Added support for completing Nexus operations before the StartOperation response is received. Operation ID, StartTime, and StartLinks were added to the completion request so that a NexusOperationStarted event can be fabricated. Depends on nexus-rpc/sdk-go#26 and temporalio/sdk-go#1710 Bumps Temporal SDK version to `v1.30.1` Bumps Nexus SDK version to `v0.0.12` ## Why?  Better user experience. ## How did you test it?  New functional test

Set Nexus operation ID on callback headers

30b6eac

pdoerner mentioned this pull request Nov 15, 2024

Support Nexus operation complete before start temporalio/temporal#6821

Merged

pdoerner requested a review from bergundy November 15, 2024 07:01

bergundy reviewed Nov 15, 2024

View reviewed changes

comment

6b0260f

pdoerner requested a review from bergundy November 19, 2024 18:46

bergundy reviewed Nov 20, 2024

View reviewed changes

return error on missing workflow ID

eb6e759

pdoerner requested review from Quinn-With-Two-Ns and bergundy November 27, 2024 16:16

Quinn-With-Two-Ns reviewed Nov 27, 2024

View reviewed changes

pdoerner and others added 2 commits November 27, 2024 09:39

bump nexus sdk version

a1cbd2d

Merge branch 'master' into nexus-complete-before-start

0866c1b

pdoerner marked this pull request as ready for review November 27, 2024 17:39

pdoerner requested a review from a team as a code owner November 27, 2024 17:39

pdoerner requested a review from Quinn-With-Two-Ns November 27, 2024 17:39

pdoerner added 2 commits November 27, 2024 09:40

error message

1dccd59

tidy

bb25b69

Quinn-With-Two-Ns reviewed Nov 27, 2024

View reviewed changes

Quinn-With-Two-Ns approved these changes Nov 27, 2024

View reviewed changes

pdoerner added 7 commits November 27, 2024 09:47

tidy

df8d203

tidy

db5178e

tidy

9c8298f

tidy

39b623e

case insensitive header

1679683

test

9437de3

test

2197e11

pdoerner merged commit 520b525 into master Nov 27, 2024
14 checks passed

pdoerner deleted the nexus-complete-before-start branch November 27, 2024 20:13

Quinn-With-Two-Ns mentioned this pull request Nov 28, 2024

Add operation Id to callback headers temporalio/sdk-java#2336

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Set Nexus operation ID on callback headers #1710

Set Nexus operation ID on callback headers #1710

pdoerner commented Nov 15, 2024 •

edited

Loading

bergundy left a comment

bergundy Nov 15, 2024

Quinn-With-Two-Ns Nov 15, 2024

bergundy Nov 18, 2024

pdoerner Nov 19, 2024

bergundy Nov 20, 2024

bergundy Nov 27, 2024

pdoerner commented Nov 19, 2024

bergundy left a comment

bergundy commented Nov 21, 2024

Quinn-With-Two-Ns Nov 27, 2024

Quinn-With-Two-Ns Nov 27, 2024

Set Nexus operation ID on callback headers #1710

Set Nexus operation ID on callback headers #1710

Conversation

pdoerner commented Nov 15, 2024 • edited Loading

What was changed

Why?

Checklist

bergundy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pdoerner commented Nov 19, 2024

bergundy left a comment

Choose a reason for hiding this comment

bergundy commented Nov 21, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pdoerner commented Nov 15, 2024 •

edited

Loading