Adding CancellationToken to context.Items to subscribe - #105
Merged
mookid8000 merged 8 commits intoOct 21, 2025
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds tracking and cancellation of message lock renewal tokens in the Azure Service Bus transport to ensure that renewal tasks can be stopped when a message is completed, abandoned, or an error occurs.
- Introduces a
_messageRenewerTokenSourcesdictionary to holdCancellationTokenSourceinstances per message. - Creates a linked cancellation token source in
Receiveand stores it in the context items. - Hooks into the
OnAck,OnNack, andOnDisposedcallbacks to remove token sources, and cancels them when renew failures occur.
Comments suppressed due to low confidence (1)
Rebus.AzureServiceBus/AzureServiceBus/AzureServiceBusTransport.cs:620
- [nitpick] Consider renaming
renewFailedTokenSourceto something likerenewalTokenSourceormessageRenewalTokenSourcefor clarity.
var renewFailedTokenSource = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken, _cancellationToken);
jesperhmraptor
approved these changes
Jun 27, 2025
Contributor
Author
|
Hi @mookid8000 |
Member
|
Great work 👍 sorry for taking so long to react though 😅 |
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.
We see a problem where Azure Service bus is never going to accept the renewal request for the locks - which results in a state where the message is never going to be completed by the handler.
This is a transient error - so instead we want to be able to fail fast.
This is done by adding a CancellationToken that can be listened to in the Handler to see whether to stop the handling of the message by throwing a OperationCancelException
Enhancements to message lock renewal and cancellation:
ConcurrentDictionarynamed_messageRenewerTokenSourcesto storeCancellationTokenSourceobjects for each message to manage cancellation tokens during lock renewal. (AzureServiceBusTransport.cs, Rebus.AzureServiceBus/AzureServiceBus/AzureServiceBusTransport.csR64)Receivemethod to create and store a linkedCancellationTokenSourcefor each message, which combines the pipeline cancellation token with a token that cancels if lock renewal fails. The token is added to the transaction context for use during message processing. (AzureServiceBusTransport.cs, Rebus.AzureServiceBus/AzureServiceBus/AzureServiceBusTransport.csL621-R628)OnAck,OnNack, andOnDisposedcallbacks of the transaction context. (AzureServiceBusTransport.cs, [1] [2] [3]AzureServiceBusTransport.cs, Rebus.AzureServiceBus/AzureServiceBus/AzureServiceBusTransport.csL968-R985)