Fix SingleConsumerUnboundedChannel WaitToReadAsync returning exception instead of false#125745
Open
Fix SingleConsumerUnboundedChannel WaitToReadAsync returning exception instead of false#125745
Conversation
…ception instead of false In TryComplete, the error variable was mutated by CreateInvalidCompletionException for the blocked reader, causing the waiting reader to incorrectly receive a ChannelClosedException instead of returning false when the channel was completed successfully. Co-authored-by: stephentoub <2642209+stephentoub@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] [ISSUE-123] Fix WaitToReadAsync exception handling
Fix SingleConsumerUnboundedChannel WaitToReadAsync returning exception instead of false
Mar 18, 2026
stephentoub
approved these changes
Mar 18, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Fixes SingleConsumerUnboundedChannel.WaitToReadAsync incorrectly faulting with ChannelClosedException (instead of returning false) after a prior cancellable ReadAsync was canceled and the channel is then completed successfully.
Changes:
- Prevent
TryCompletefrom mutating the sharederrorvariable when completing a blocked reader, so waiting readers observe the correct completion state. - Add a regression test covering the canceled-
ReadAsync→WaitToReadAsync→ normalComplete()sequence.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/libraries/System.Threading.Channels/src/System/Threading/Channels/SingleConsumerUnboundedChannel.cs | Avoids reassigning error when completing a blocked reader, preventing incorrect exception propagation to a waiting reader. |
| src/libraries/System.Threading.Channels/tests/UnboundedChannelTests.cs | Adds regression coverage for WaitToReadAsync returning false after normal completion following a canceled ReadAsync. |
You can also share your feedback on Copilot code review. Take the survey.
src/libraries/System.Threading.Channels/tests/UnboundedChannelTests.cs
Outdated
Show resolved
Hide resolved
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Contributor
|
Tagging subscribers to this area: @dotnet/area-system-threading-channels |
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.
Description
SingleConsumerUnboundedChannel.WaitToReadAsyncthrowsChannelClosedExceptioninstead of returningfalsewhen a priorReadAsyncwas cancelled and the channel is then completed normally.In
TryComplete, theerrorvariable is mutated byCreateInvalidCompletionExceptionwhen completing the blocked reader, then the now-non-nullerroris incorrectly propagated to the waiting reader:Fix: inline the call so
erroris never reassigned.Adds a regression test covering the exact sequence:
ReadAsynccancelled →WaitToReadAsync→Complete()→ expectfalse.📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.