[azservicebus] Fixing bug where you could lose messages in ReceiveAndDelete #24864
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
…ad left over credits before you closed.
API Change CheckAPIView identified API level changes in this PR and created the following API reviews |
Member
Author
|
/azp run go - azservicebus |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Member
Author
|
/azp run go - azservicebus |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes an issue where messages may be lost in ReceiveAndDelete mode by allowing calls to ReceiveMessages even after the receiver is closed, draining any cached messages.
- Documentation and comments have been updated to reference new error types and behavior.
- Caching logic was added to the receiver to store prefetched messages and enable later retrieval.
- New tests and examples verify the new behavior and document proper usage.
Reviewed Changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| sdk/messaging/azservicebus/session_receiver.go | Updated documentation comments to reference new error types and settlement methods |
| sdk/messaging/azservicebus/sender.go | Updated error documentation in sender methods |
| sdk/messaging/azservicebus/receiver_test.go | Added new tests to verify cached message retrieval in ReceiveAndDelete mode |
| sdk/messaging/azservicebus/receiver.go | Introduced caching logic and the receiveFromCache helper to drain cached messages |
| sdk/messaging/azservicebus/message.go | Adjusted newReceivedMessage to safely handle nil receivers |
| sdk/messaging/azservicebus/internal/amqpLinks.go | Updated error handling to use a shared errClosed value and push cached messages after close |
| sdk/messaging/azservicebus/example_receiver_test.go | Added new example demonstrating the ReceiveAndDelete flow post-close |
| sdk/messaging/azservicebus/client.go | Updated documentation in session receiver creation methods |
| sdk/messaging/azservicebus/CHANGELOG.md | Added changelog entry detailing the bug fix |
…essages without some coordination.
Member
Author
|
/azp run go - azservicebus |
|
Azure Pipelines successfully started running 1 pipeline(s). |
…s just get all 2000 and under normal conditions we do. However, it's not guaranteed so I've added an extra step to drain the queue of any remaining messages and check that we truly haven't lost anything.
Member
Author
|
/azp run go - azservicebus |
Member
Author
|
(Just a note, the test failure was just a problem with my test, not the package code) |
|
Azure Pipelines successfully started running 1 pipeline(s). |
jhendrixMSFT
reviewed
Jul 8, 2025
jhendrixMSFT
reviewed
Jul 8, 2025
jhendrixMSFT
approved these changes
Jul 8, 2025
Member
Author
|
/azp run go - azservicebus |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR makes it so you can call ReceiveMessages after a Receiver (only in ReceiveAndDelete mode) is closed, giving you access to any cached messages that might have arrived after your final ReceiveMessages() call, but before Close().
Fixes #24078