-
Notifications
You must be signed in to change notification settings - Fork 16
feat: add AsReconciler wrapper to rate limit and replace controller-runtime's requeue: true behavior #160
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
rschalo
wants to merge
5
commits into
main
Choose a base branch
from
default-singleton-rate-limiter
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
feat: add AsReconciler wrapper to rate limit and replace controller-runtime's requeue: true behavior #160
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
790cf1c
feat: add default singleton rate limiter to replace requeue
rschalo 65907aa
feat: Add requeue adapter for rate-limiting
rschalo b44f368
clean up
rschalo 956678b
fix presubmit
rschalo 4c6d4c3
Merge branch 'main' into default-singleton-rate-limiter
rschalo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
package reconciler | ||
|
||
import ( | ||
"context" | ||
|
||
"k8s.io/client-go/util/workqueue" | ||
"sigs.k8s.io/controller-runtime/pkg/reconcile" | ||
) | ||
|
||
// Result is a wrapper around reconcile.Result that adds RequeueWithBackoff functionality. | ||
type Result struct { | ||
reconcile.Result | ||
RequeueWithBackoff bool | ||
} | ||
|
||
// KeyExtractor extracts a rate limiter key from a context and reconcile.Request. | ||
type KeyExtractor[K any] interface { | ||
Extract(ctx context.Context, req reconcile.Request) K | ||
} | ||
|
||
// RequestKeyExtractor extracts a reconcile.Request key for rate limiting. | ||
type RequestKeyExtractor struct{} | ||
|
||
// Extract returns the reconcile.Request as the key. | ||
func (e RequestKeyExtractor) Extract(ctx context.Context, req reconcile.Request) reconcile.Request { | ||
return req | ||
} | ||
|
||
// Reconciler defines the interface for standard reconcilers | ||
type Reconciler interface { | ||
Reconcile(ctx context.Context) (Result, error) | ||
} | ||
|
||
// ReconcilerFunc is a function type that implements the Reconciler interface. | ||
type ReconcilerFunc func(ctx context.Context) (Result, error) | ||
|
||
// Reconcile implements the Reconciler interface. | ||
func (f ReconcilerFunc) Reconcile(ctx context.Context) (Result, error) { | ||
return f(ctx) | ||
} | ||
|
||
// AsReconciler creates a reconciler from a standard reconciler | ||
func AsReconciler(reconciler Reconciler) reconcile.Reconciler { | ||
return AsGenericReconciler( | ||
func(ctx context.Context, req reconcile.Request) (Result, error) { | ||
return reconciler.Reconcile(ctx) | ||
}, | ||
RequestKeyExtractor{}, | ||
) | ||
} | ||
|
||
// AsGenericReconciler creates a reconciler with a specific key extractor | ||
func AsGenericReconciler[K comparable]( | ||
reconcileFunc func(ctx context.Context, req reconcile.Request) (Result, error), | ||
keyExtractor KeyExtractor[K], | ||
) reconcile.Reconciler { | ||
return AsGenericReconcilerWithRateLimiter( | ||
reconcileFunc, | ||
keyExtractor, | ||
workqueue.DefaultTypedControllerRateLimiter[K](), | ||
) | ||
} | ||
|
||
// AsGenericReconcilerWithRateLimiter creates a reconciler with a custom rate limiter | ||
func AsGenericReconcilerWithRateLimiter[K comparable]( | ||
reconcileFunc func(ctx context.Context, req reconcile.Request) (Result, error), | ||
keyExtractor KeyExtractor[K], | ||
rateLimiter workqueue.TypedRateLimiter[K], | ||
) reconcile.Reconciler { | ||
return reconcile.Func(func(ctx context.Context, req reconcile.Request) (reconcile.Result, error) { | ||
result, err := reconcileFunc(ctx, req) | ||
if err != nil { | ||
return reconcile.Result{}, err | ||
} | ||
if result.RequeueWithBackoff { | ||
return reconcile.Result{RequeueAfter: rateLimiter.When(keyExtractor.Extract(ctx, req))}, nil | ||
} | ||
return result.Result, nil | ||
}) | ||
} |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Discussed offline - dropping in favor of two separate wrappers.