Add QueueException and guard against reusing behavior instances#448
Merged
Add QueueException and guard against reusing behavior instances#448
Conversation
Add QueueException following the established pattern (CacheException, StorageException, MessageBusException) to provide a consistent exception type for queue operations. Add a guard in QueueBehaviorBase.Attach that throws QueueException if the behavior is already attached to a queue, preventing subtle bugs from duplicate event handler subscriptions or stale queue references. Include documentation updates in docs/guide/queues.md with behavior attachment rules and QueueException usage, plus two new tests following naming standards. Co-authored-by: Cursor <cursoragent@cursor.com>
niemyjski
requested review from
Copilot and
ejsmith
and removed request for
Copilot
Member
Author
|
In exceptionless and other apps I've seen usages of where behaviors are created via new instances on queues. But I do see |
ejsmith
approved these changes
Feb 6, 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
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.
Summary
QueueExceptionfollowing the established pattern (CacheException,StorageException,MessageBusException) to provide a consistent exception type for queue-specific errorsQueueBehaviorBase<T>.Attach()that throwsQueueExceptionif the behavior is already attached to a queue, preventing subtle bugs from duplicate event handler subscriptions or stale_queuereferences when reusing a single behavior instance across multiple queuesQueueExceptionindocs/guide/queues.mdChanges
src/Foundatio/Queues/QueueException.csmessageandmessage + innerExceptionconstructorssrc/Foundatio/Queues/QueueBehaviour.csArgumentNullExceptionguard +QueueExceptionif already attacheddocs/guide/queues.mdtests/.../InMemoryQueueTests.csAttachBehavior_WhenAlreadyAttached_ThrowsQueueExceptionandAttachBehavior_WithNullQueue_ThrowsArgumentNullExceptionTest plan
AttachBehavior_WhenAlreadyAttached_ThrowsQueueException— verifies the guard throws when reusing a behavior across two queuesAttachBehavior_WithNullQueue_ThrowsArgumentNullException— verifies null argument guardCanQueueAndDequeueMultipleWorkItemsAsync)