Remove Cancel from the Job interface
#3127
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
StephenButtolph
added
consensus
marun
reviewed
Jun 18, 2024
| // Job is a unit of work that can be executed based on the result of resolving | ||
| // requested dependencies. | ||
| type Job[T any] interface { | ||
| Execute(ctx context.Context, fulfilled []T, abandoned []T) error |
There was a problem hiding this comment.
So this was the price for getting rid of Cancel - needing to provide more context to Execute in the form of the fulfilled/abandoned slices?
There was a problem hiding this comment.
correct. I think this makes it implicitly clear that every dependency is going to be resolved before execution. Whereas before the reliance on no short-circuiting for Cancel wasn't clear
marun
approved these changes
Jun 18, 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.
Why this should be merged
The prior implementation seemed to be a bit unintuitive with how cancellation was implemented and used by the
voterjob. This PR is attempting to make the behavior as explicit as possible.How this works
Rather than having
ExecuteandCancelfunction that are called, there is a singleExecutewhich takes in the results of resolving the dependencies.How this was tested