Add functional test for attaching callbacks in Nexus operations #7364
+160
−0
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
bergundy
reviewed
Feb 19, 2025
rodrigozhou
added a commit
that referenced
this pull request
Feb 20, 2025
## What changed? <!-- Describe what has changed in this PR --> Make `OnConflictOptions.AttachRequestId` required if `OnConflictOptions.AttachCompletionCallbacks` is set. Change the callback state machine ID builder to use the request ID instead of the history event ID. ## Why? <!-- Tell your future self why have you made these changes --> Attaching a callback to a running workflow creates the `WorkflowExecutionOptionsUpdated` event, which can be buffered. In this case, the history event ID does not "exist" yet, and cannot be used to generate the callback state machine ID. ## How did you test it? <!-- How have you verified this change? Tested locally? Added a unit test? Checked in staging env? --> PR #7364 has tests that validates that this fix works. ## Potential risks <!-- Assuming the worst case, what can be broken when deploying this change to production? --> ## Documentation <!-- Have you made sure this change doesn't falsify anything currently stated in `docs/`? If significant new behavior is added, have you described that in `docs/`? --> ## Is hotfix candidate? <!-- Is this PR a hotfix candidate or does it require a notification to be sent to the broader community? (Yes/No) -->
rodrigozhou
force-pushed
the
rodrigozhou/nexus-sdk-tests
branch
from
6c1623d to
280426b
Compare
rodrigozhou
added a commit
that referenced
this pull request
Feb 20, 2025
## What changed? <!-- Describe what has changed in this PR --> Make `OnConflictOptions.AttachRequestId` required if `OnConflictOptions.AttachCompletionCallbacks` is set. Change the callback state machine ID builder to use the request ID instead of the history event ID. ## Why? <!-- Tell your future self why have you made these changes --> Attaching a callback to a running workflow creates the `WorkflowExecutionOptionsUpdated` event, which can be buffered. In this case, the history event ID does not "exist" yet, and cannot be used to generate the callback state machine ID. ## How did you test it? <!-- How have you verified this change? Tested locally? Added a unit test? Checked in staging env? --> PR #7364 has tests that validates that this fix works. ## Potential risks <!-- Assuming the worst case, what can be broken when deploying this change to production? --> ## Documentation <!-- Have you made sure this change doesn't falsify anything currently stated in `docs/`? If significant new behavior is added, have you described that in `docs/`? --> ## Is hotfix candidate? <!-- Is this PR a hotfix candidate or does it require a notification to be sent to the broader community? (Yes/No) -->
rodrigozhou
force-pushed
the
rodrigozhou/nexus-sdk-tests
branch
from
280426b to
b2e092d
Compare
rodrigozhou
force-pushed
the
rodrigozhou/nexus-sdk-tests
branch
from
b2e092d to
0e66c57
Compare
bergundy
approved these changes
Feb 28, 2025
Comment on lines
+2257
to
+2294
| for i := 0; i < numCalls; i++ { | ||
| wg.Add(1) | ||
| workflow.Go(ctx, func(ctx workflow.Context) { | ||
| defer wg.Done() | ||
| fut := c.ExecuteOperation(ctx, op, input, workflow.NexusOperationOptions{}) | ||
| var exec workflow.NexusOperationExecution | ||
| err := fut.GetNexusOperationExecution().Get(ctx, &exec) | ||
| if err != nil { | ||
| output.CntErr++ | ||
| var handlerErr *nexus.HandlerError | ||
| var appErr *temporal.ApplicationError | ||
| if !errors.As(err, &handlerErr) { | ||
| retError = err | ||
| } else if !errors.As(handlerErr, &appErr) { | ||
| retError = err | ||
| } else if appErr.Type() != "WorkflowExecutionAlreadyStarted" { | ||
| retError = err | ||
| } | ||
| } else { | ||
| output.CntOk++ | ||
| } | ||
| execOpCh.Send(ctx, nil) | ||
| if err != nil { | ||
| return | ||
| } | ||
| var res string | ||
| err = fut.Get(ctx, &res) | ||
| if err != nil { | ||
| retError = err | ||
| } else if res != "hello "+input { | ||
| retError = fmt.Errorf("unexpected result from handler workflow: %q", res) | ||
| } | ||
| }) | ||
| } | ||
|
|
||
| for i := 0; i < numCalls; i++ { | ||
| execOpCh.Receive(ctx, nil) | ||
| } |
There was a problem hiding this comment.
Would have been much easier to follow if you put all of the futures returned from c.ExecuteOperation into a slice, iterate over them and GetNexusOperationFuture().Get() on them, signal, and then call Get() on the futures.
No need for the goroutines, wait group, and channel IMHO since you don't care about getting the results concurrently.
| } | ||
|
|
||
| // number of concurrent Nexus operation calls | ||
| numCalls := 5 |
There was a problem hiding this comment.
Why pass this around when you can just define it at the top of the test?
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 changed?
Add functional test for attaching callbacks in Nexus operations
Why?
How did you test it?
Potential risks
Documentation
Is hotfix candidate?