Fixes ServiceBus PeekMessageAsync Cancellation Token bug #2433
Conversation
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
ServiceBusReceiver.PeekMessageAsync does not necessarily respect the cancellation token. See Azure/azure-sdk-for-net#52620. To get around this limitation, we create a task with the cancellation token and use WhenAny to return on cancel even if the receiver hasn't returned. We also add tests to validate the correct behavior.
|
@dotnet-policy-service agree |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 this PR does / why we need it:
ServiceBusReceiver.PeekMessageAsync does not necessarily respect the cancellation token. See Azure/azure-sdk-for-net#52620. This causes the SB Queue and Subscription health checks to not return. In production environments where request timeouts and output cache for health endpoints are vital to avoiding health check cascading and DDOS attacks, this limitation prevents the usual request timeout and output caching patterns in AspNet Core from operating correctly.
To get around this, this PR fails the health check if the receiver.PeekMessage does not return before the cancellation token is triggered.
Which issue(s) this PR fixes:
Please reference the issue this PR will close: #2432
Does this PR introduce a user-facing change?: No
Please make sure you've completed the relevant tasks for this PR, out of the following list: