Add EnqueueAfter and RequeueAfter option to queue #318
Conversation
This file contains 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
ghost
changed the title
ghost
This commit adds an option for an item to be enqueued after a specified duration. During that duration the item can not be enqueued if requested through Enqueue to ensure that the item is not enqueued before that duration is completed. This allows reconcilers to delay reconciliation for an item when it knows it will be performing an operation which takes longer than the polling cycle preventing the poller from requeuing that item. RequeueAfter is a wrapper around Done() followed by EnqueueAfter() done under the same lock to prevent race condition when an item could be requeued between Done and the EnqueueAfter call. Also adds a new error type, RequeueAfterError, which can be returned by a reconcile function to indicate that an item should be requeued after a certain duration. This should only be used as an optimisation and the pollers and reconcilers should be designed to pick up correctly from a restart of the system.
FrimIdan
reviewed
May 28, 2023
| _, isProcessing := q.processing[item] | ||
| _, isWaitingForEnqueue := q.waitingForEnqueue[item] | ||
| if inQueue || isProcessing || isWaitingForEnqueue { | ||
| // item is already known by the queue so there is nothing to do |
There was a problem hiding this comment.
@sambetts-cisco maybe a warning is needed here, it is probably a "bug" that you try to enqueueAfter for an already known item.
This pull request was closed.
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
This commit adds an option for an item to be enqueued after a specified
duration. During that duration the item can not be enqueued if requested
through Enqueue to ensure that the item is not enqueued before that
duration is completed.
This allows reconcilers to delay reconciliation for an item when it
knows it will be performing an operation which takes longer than the
polling cycle preventing the poller from requeuing that item.
RequeueAfter is a wrapper around Done() followed by EnqueueAfter() done
under the same lock to prevent race condition when an item could be
requeued between Done and the EnqueueAfter call.
Also adds a new error type, RequeueAfterError, which can be returned by
a reconcile function to indicate that an item should be requeued after a
certain duration. This should only be used as an optimisation and the
pollers and reconcilers should be designed to pick up correctly from a
restart of the system.
Type of Change
[ ] Bug Fix
[ ] New Feature
[ ] Breaking Change
[X] Refactor
[ ] Documentation
[ ] Other (please describe)
Checklist