Error for unused Update operation #1655
Merged
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
stephanos
force-pushed
the
multiops-unused-err
branch
from
c596400
to
2c8a4a5
Compare
stephanos
force-pushed
the
multiops-unused-err
branch
from
2c8a4a5
to
88e19cd
Compare
stephanos
commented
Oct 2, 2024
| @@ -746,7 +746,7 @@ type ( | |||
| // workflow completion callback. Only settable by the SDK - e.g. [temporalnexus.workflowRunOperation]. | |||
| callbacks []*commonpb.Callback | |||
| // links. Only settable by the SDK - e.g. [temporalnexus.workflowRunOperation]. | |||
| links []*commonpb.Link | |||
| links []*commonpb.Link | |||
There was a problem hiding this comment.
Huh? Seems correct now.
stephanos
commented
Oct 2, 2024
| require.NoError(s.T(), err) | ||
|
|
||
| _, err = updOp.Get(ctxWithTimeout) | ||
| require.EqualError(s.T(), err, "context deadline exceeded: operation was not executed") |
There was a problem hiding this comment.
I'm assuming the cause of the deadline should be on the right.
stephanos
changed the title
internal/client.go
Outdated
| @@ -1082,6 +1082,9 @@ func (op *UpdateWithStartWorkflowOperation) Get(ctx context.Context) (WorkflowUp | |||
| case <-op.doneCh: | |||
| return op.handle, op.err | |||
| case <-ctx.Done(): | |||
| if !op.executed.Load() { | |||
| return nil, fmt.Errorf("%v: %v", ctx.Err(), fmt.Errorf("operation was not executed")) | |||
There was a problem hiding this comment.
for error wrapping shouldn't one of these be a %w?
There was a problem hiding this comment.
Indeed! I just learned that Go 1.20 supports multiple %w, changing it to that now.
Quinn-With-Two-Ns
approved these changes
Oct 3, 2024
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 was changed
When the request for the update operation's handle times out, it now returns a more specific error if the operation was never actually executed as part of a MultiOperation.
Why?
It's easy to forget to specify
WithStartOperation(happened to me when I worked on a Go sample). This signals more clearly to the user that they forgot to run it. However, IMO the error cannot be more specific than that, since there could be other reasons why the operation was never executed.Checklist
Closes
How was this tested: