Add cancelled token handling for consumers#1068
Merged
Merged
Conversation
Adjusted consumer methods to respect cancellation tokens, ensuring proper exception handling and behavior during cancellation scenarios.
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request addresses issue #1066 by adding early cancellation token checks to JetStream consumer methods. The issue reported that calling FetchAsync with an already-cancelled token would still reserve messages from the NATS server without throwing an exception. The fix ensures that consumer methods check the cancellation token before making any server requests, preventing message reservation when cancellation has already been requested.
Changes:
- Added
cancellationToken.ThrowIfCancellationRequested()calls to internal consumer methods inNatsJSConsumer - Added early cancellation checks to public async enumerable methods in
NatsJSOrderedConsumer - Added comprehensive test coverage for all consumer methods with pre-cancelled tokens
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| tests/NATS.Client.JetStream.Tests/CancellationTokenTests.cs | New test file with 6 test methods covering FetchAsync, FetchNoWaitAsync, NextAsync, and ConsumeAsync for both regular and ordered consumers |
| src/NATS.Client.JetStream/NatsJSConsumer.cs | Added cancellation token checks in ConsumeInternalAsync and FetchInternalAsync methods |
| src/NATS.Client.JetStream/NatsJSOrderedConsumer.cs | Added cancellation token checks at the beginning of ConsumeAsync, FetchAsync, and FetchNoWaitAsync methods |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
mtmk
added a commit
that referenced
this pull request
Mar 13, 2026
* Add optional window_size parameter to StreamSnapshotRequest (#1088) * Bump Microsoft.Bcl.Memory from 9.0.0 to 9.0.14 (#1089) * Fix `PingCommand` cancellation (#1086) * rework terminate reason (#1081) * Fix OTel network telemetry tags (#1078) * Add consumer info usage warnings (#1079) * Add TermWithReason support to AckTerminateAsync (#1048) * Fix code analyser warning (#1076) * Add cancelled token handling for consumers (#1068) * Add validation for unsupported PinnedClient calls (#1063) * Add see-also references to Orbit packages (#1077) * Add Synadia.Orbit.Testing.NatsServerProcessManager (#1065) * Add slow consumer docs (#1073) * Fix error logs URI rewritten by OnConnectingAsync (#1067) * Add more tests for JetStream consumer behavior (#1055)
Merged
mtmk
added a commit
that referenced
this pull request
Mar 13, 2026
* Add optional window_size parameter to StreamSnapshotRequest (#1088) * Bump Microsoft.Bcl.Memory from 9.0.0 to 9.0.14 (#1089) * Fix `PingCommand` cancellation (#1086) * rework terminate reason (#1081) * Fix OTel network telemetry tags (#1078) * Add consumer info usage warnings (#1079) * Add TermWithReason support to AckTerminateAsync (#1048) * Fix code analyser warning (#1076) * Add cancelled token handling for consumers (#1068) * Add validation for unsupported PinnedClient calls (#1063) * Add see-also references to Orbit packages (#1077) * Add Synadia.Orbit.Testing.NatsServerProcessManager (#1065) * Add slow consumer docs (#1073) * Fix error logs URI rewritten by OnConnectingAsync (#1067) * Add more tests for JetStream consumer behavior (#1055)
This was referenced Jul 12, 2026
This was referenced Jul 20, 2026
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
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.
Adjusted consumer methods to respect cancellation tokens, ensuring proper exception handling and behavior during cancellation scenarios.
Resolves #1066