-
Notifications
You must be signed in to change notification settings - Fork 6
feat(batch): configurable context-cancellation mode (WithCancelMode) #76
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
MasterOfBinary
wants to merge
3
commits into
fix/engine-hardening
Choose a base branch
from
feat/cancel-mode
base: fix/engine-hardening
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| package batch | ||
|
|
||
| // CancelMode controls how a Batch reacts to context cancellation. | ||
| // | ||
| // The zero value is CancelDrain, which preserves the historical behavior: | ||
| // items already read from the Source are still processed and the Batch relies | ||
| // on the Source to stop producing and close its channels. | ||
| type CancelMode int | ||
|
|
||
| const ( | ||
| // CancelDrain (the default) keeps processing items already read from the | ||
| // Source when the context is canceled, relying on the Source to stop | ||
| // producing and close its channels. Nothing already read into the pipeline | ||
| // is dropped. (Internal error sends remain context-aware so a full, | ||
| // undrained error channel still cannot deadlock the pipeline.) | ||
| CancelDrain CancelMode = iota | ||
|
|
||
| // CancelStop makes the Batch stop reading promptly when the context is | ||
| // canceled instead of waiting for the Source. Items already buffered in the | ||
| // pipeline are still processed, but items not yet read from the Source may | ||
| // be dropped. | ||
| CancelStop | ||
| ) |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To prevent bugs and ensure defensive programming, it is highly recommended to validate the
CancelModeinput inWithCancelMode. SinceCancelModeis an integer type, an invalid value (e.g.,42) could be passed, which would silently fall back toCancelDrainbehavior and make debugging difficult.