Removed deprecated DefaultControllerRateLimiter

LalatenduMohanty · LalatenduMohanty · commit 375ee9465003 · 2024-11-13T01:22:00.000+05:00
Use DefaultTypedControllerRateLimiter instead of workqueue.DefaultControllerRateLimiter

Signed-off-by: Lalatendu Mohanty &lt;lmohanty@redhat.com&gt;
diff --git a/pkg/autoupdate/autoupdate.go b/pkg/autoupdate/autoupdate.go
@@ -48,7 +48,7 @@ type Controller struct {
 	cacheSynced []cache.InformerSynced
 
 	// queue tracks keeping the list of available updates on a cluster version
-	queue workqueue.RateLimitingInterface
+	queue workqueue.TypedRateLimitingInterface[any]
 }
 
 // New returns a new autoupdate controller.
@@ -68,7 +68,7 @@ func New(
 		name:          name,
 		client:        client,
 		eventRecorder: eventBroadcaster.NewRecorder(scheme.Scheme, corev1.EventSource{Component: "autoupdater"}),
-		queue:         workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), "autoupdater"),
+		queue:         workqueue.NewTypedRateLimitingQueueWithConfig[any](workqueue.DefaultTypedControllerRateLimiter[any](), workqueue.TypedRateLimitingQueueConfig[any]{Name: "autoupdater"}),
 	}
 
 	if _, err := cvInformer.Informer().AddEventHandler(ctrl.eventHandler()); err != nil {
diff --git a/pkg/cvo/availableupdates_test.go b/pkg/cvo/availableupdates_test.go
@@ -121,7 +121,7 @@ func newOperator(url, version string, promqlMock clusterconditions.Condition) (*
 		proxyLister:           notFoundProxyLister{},
 		cmConfigManagedLister: notFoundConfigMapLister{},
 		conditionRegistry:     registry,
-		queue:                 workqueue.NewRateLimitingQueue(workqueue.DefaultControllerRateLimiter()),
+		queue:                 workqueue.NewTypedRateLimitingQueue[any](workqueue.DefaultTypedControllerRateLimiter[any]()),
 		release:               currentRelease,
 	}
 	availableUpdates := &availableUpdates{
diff --git a/pkg/cvo/cvo.go b/pkg/cvo/cvo.go
@@ -120,11 +120,11 @@ type Operator struct {
 	cacheSynced           []cache.InformerSynced
 
 	// queue tracks applying updates to a cluster.
-	queue workqueue.RateLimitingInterface
+	queue workqueue.TypedRateLimitingInterface[any]
 	// availableUpdatesQueue tracks checking for updates from the update server.
-	availableUpdatesQueue workqueue.RateLimitingInterface
+	availableUpdatesQueue workqueue.TypedRateLimitingInterface[any]
 	// upgradeableQueue tracks checking for upgradeable.
-	upgradeableQueue workqueue.RateLimitingInterface
+	upgradeableQueue workqueue.TypedRateLimitingInterface[any]
 
 	// statusLock guards access to modifying available updates
 	statusLock       sync.Mutex
@@ -217,13 +217,12 @@ func New(
 		payloadDir:                 overridePayloadDir,
 		updateService:              updateService,
 
-		client:        client,
-		kubeClient:    kubeClient,
-		eventRecorder: eventBroadcaster.NewRecorder(scheme.Scheme, corev1.EventSource{Component: namespace}),
-
-		queue:                 workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), "clusterversion"),
-		availableUpdatesQueue: workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), "availableupdates"),
-		upgradeableQueue:      workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), "upgradeable"),
+		client:                client,
+		kubeClient:            kubeClient,
+		eventRecorder:         eventBroadcaster.NewRecorder(scheme.Scheme, corev1.EventSource{Component: namespace}),
+		queue:                 workqueue.NewTypedRateLimitingQueueWithConfig[any](workqueue.DefaultTypedControllerRateLimiter[any](), workqueue.TypedRateLimitingQueueConfig[any]{Name: "clusterversion"}),
+		availableUpdatesQueue: workqueue.NewTypedRateLimitingQueueWithConfig[any](workqueue.DefaultTypedControllerRateLimiter[any](), workqueue.TypedRateLimitingQueueConfig[any]{Name: "availableupdates"}),
+		upgradeableQueue:      workqueue.NewTypedRateLimitingQueueWithConfig[any](workqueue.DefaultTypedControllerRateLimiter[any](), workqueue.TypedRateLimitingQueueConfig[any]{Name: "upgradeable"}),
 
 		exclude:                   exclude,
 		clusterProfile:            clusterProfile,
@@ -607,14 +606,14 @@ func clusterOperatorConditionStatus(co *configv1.ClusterOperator, condType confi
 	return configv1.ConditionUnknown
 }
 
-func (optr *Operator) worker(ctx context.Context, queue workqueue.RateLimitingInterface, syncHandler func(context.Context, string) error) {
+func (optr *Operator) worker(ctx context.Context, queue workqueue.TypedRateLimitingInterface[any], syncHandler func(context.Context, string) error) {
 	for processNextWorkItem(ctx, queue, syncHandler, optr.syncFailingStatus) {
 	}
 }
 
 type syncFailingStatusFunc func(ctx context.Context, config *configv1.ClusterVersion, err error) error
 
-func processNextWorkItem(ctx context.Context, queue workqueue.RateLimitingInterface, syncHandler func(context.Context, string) error, syncFailingStatus syncFailingStatusFunc) bool {
+func processNextWorkItem(ctx context.Context, queue workqueue.TypedRateLimitingInterface[any], syncHandler func(context.Context, string) error, syncFailingStatus syncFailingStatusFunc) bool {
 	key, quit := queue.Get()
 	if quit {
 		return false
@@ -626,7 +625,7 @@ func processNextWorkItem(ctx context.Context, queue workqueue.RateLimitingInterf
 	return true
 }
 
-func handleErr(ctx context.Context, queue workqueue.RateLimitingInterface, err error, key interface{}, syncFailingStatus syncFailingStatusFunc) {
+func handleErr(ctx context.Context, queue workqueue.TypedRateLimitingInterface[any], err error, key interface{}, syncFailingStatus syncFailingStatusFunc) {
 	if err == nil {
 		queue.Forget(key)
 		return
diff --git a/pkg/cvo/cvo_scenarios_test.go b/pkg/cvo/cvo_scenarios_test.go
@@ -115,7 +115,7 @@ func setupCVOTest(payloadDir string) (*Operator, map[string]apiruntime.Object, *
 	o := &Operator{
 		namespace:           "test",
 		name:                "version",
-		queue:               workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), "cvo-loop-test"),
+		queue:               workqueue.NewTypedRateLimitingQueueWithConfig[any](workqueue.DefaultTypedControllerRateLimiter[any](), workqueue.TypedRateLimitingQueueConfig[any]{Name: "cvo-loop-test"}),
 		client:              client,
 		enabledFeatureGates: featuregates.DefaultCvoGates("version"),
 		cvLister:            &clientCVLister{client: client},
diff --git a/pkg/cvo/cvo_test.go b/pkg/cvo/cvo_test.go
@@ -2775,7 +2775,7 @@ func TestOperator_availableUpdatesSync(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			optr := tt.optr
-			optr.queue = workqueue.NewRateLimitingQueue(workqueue.DefaultControllerRateLimiter())
+			optr.queue = workqueue.NewTypedRateLimitingQueue[any](workqueue.DefaultTypedControllerRateLimiter[any]())
 			optr.proxyLister = &clientProxyLister{client: optr.client}
 			optr.coLister = &clientCOLister{client: optr.client}
 			optr.cvLister = &clientCVLister{client: optr.client}
@@ -3868,7 +3868,7 @@ func TestOperator_upgradeableSync(t *testing.T) {
 		{
 			t.Run(tt.name, func(t *testing.T) {
 				optr := tt.optr
-				optr.queue = workqueue.NewRateLimitingQueue(workqueue.DefaultControllerRateLimiter())
+				optr.queue = workqueue.NewTypedRateLimitingQueue[any](workqueue.DefaultTypedControllerRateLimiter[any]())
 				optr.proxyLister = &clientProxyLister{client: optr.client}
 				optr.coLister = &clientCOLister{client: optr.client}
 				optr.cvLister = &clientCVLister{client: optr.client}
diff --git a/pkg/featuregates/featurechangestopper.go b/pkg/featuregates/featurechangestopper.go
@@ -25,7 +25,7 @@ type ChangeStopper struct {
 	featureGateLister configlistersv1.FeatureGateLister
 	cacheSynced       []cache.InformerSynced
 
-	queue      workqueue.RateLimitingInterface
+	queue      workqueue.TypedRateLimitingInterface[any]
 	shutdownFn context.CancelFunc
 }
 
@@ -34,7 +34,7 @@ func NewChangeStopper(featureGateInformer configinformersv1.FeatureGateInformer)
 	c := &ChangeStopper{
 		featureGateLister: featureGateInformer.Lister(),
 		cacheSynced:       []cache.InformerSynced{featureGateInformer.Informer().HasSynced},
-		queue:             workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), "feature-gate-stopper"),
+		queue:             workqueue.NewTypedRateLimitingQueueWithConfig[any](workqueue.DefaultTypedControllerRateLimiter[any](), workqueue.TypedRateLimitingQueueConfig[any]{Name: "feature-gate-stopper"}),
 	}
 	c.queue.Add("cluster") // seed an initial sync, in case startingRequiredFeatureSet is wrong
 	if _, err := featureGateInformer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{
diff --git a/pkg/updatestatus/controlplaneinformer_test.go b/pkg/updatestatus/controlplaneinformer_test.go
@@ -254,10 +254,10 @@ func makeTestClusterVersion(progressing *configv1.ClusterOperatorStatusCondition
 type testSyncContext struct {
 	queueKey      string
 	eventRecorder events.Recorder
-	queue         workqueue.RateLimitingInterface
+	queue         workqueue.TypedRateLimitingInterface[any]
 }
 
-func (c testSyncContext) Queue() workqueue.RateLimitingInterface {
+func (c testSyncContext) Queue() workqueue.RateLimitingInterface { //nolint:staticcheck
 	return c.queue
 }
 
diff --git a/pkg/updatestatus/updatestatuscontroller_test.go b/pkg/updatestatus/updatestatuscontroller_test.go
@@ -154,6 +154,6 @@ func Test_updateStatusController(t *testing.T) {
 func newTestSyncContextWithQueue() factory.SyncContext {
 	return testSyncContext{
 		eventRecorder: events.NewInMemoryRecorder("test"),
-		queue:         workqueue.NewRateLimitingQueue(workqueue.DefaultControllerRateLimiter()),
+		queue:         workqueue.NewTypedRateLimitingQueue(workqueue.DefaultTypedControllerRateLimiter[any]()),
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ type Controller struct {`
`48`	`48`	`cacheSynced []cache.InformerSynced`
`49`	`49`
`50`	`50`	`// queue tracks keeping the list of available updates on a cluster version`
`51`		`- queue workqueue.RateLimitingInterface`
	`51`	`+ queue workqueue.TypedRateLimitingInterface[any]`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`// New returns a new autoupdate controller.`
`@@ -68,7 +68,7 @@ func New(`
`68`	`68`	`name: name,`
`69`	`69`	`client: client,`
`70`	`70`	`eventRecorder: eventBroadcaster.NewRecorder(scheme.Scheme, corev1.EventSource{Component: "autoupdater"}),`
`71`		`- queue: workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), "autoupdater"),`
	`71`	`+ queue: workqueue.NewTypedRateLimitingQueueWithConfig[any](workqueue.DefaultTypedControllerRateLimiter[any](), workqueue.TypedRateLimitingQueueConfig[any]{Name: "autoupdater"}),`
`72`	`72`	`}`
`73`	`73`
`74`	`74`	`if _, err := cvInformer.Informer().AddEventHandler(ctrl.eventHandler()); err != nil {`
Original file line number	Diff line number	Diff line change
`@@ -121,7 +121,7 @@ func newOperator(url, version string, promqlMock clusterconditions.Condition) (*`
`121`	`121`	`proxyLister: notFoundProxyLister{},`
`122`	`122`	`cmConfigManagedLister: notFoundConfigMapLister{},`
`123`	`123`	`conditionRegistry: registry,`
`124`		`- queue: workqueue.NewRateLimitingQueue(workqueue.DefaultControllerRateLimiter()),`
	`124`	`+ queue: workqueue.NewTypedRateLimitingQueue[any](workqueue.DefaultTypedControllerRateLimiter[any]()),`
`125`	`125`	`release: currentRelease,`
`126`	`126`	`}`
`127`	`127`	`availableUpdates := &availableUpdates{`
Original file line number	Diff line number	Diff line change
`@@ -254,10 +254,10 @@ func makeTestClusterVersion(progressing *configv1.ClusterOperatorStatusCondition`
`254`	`254`	`type testSyncContext struct {`
`255`	`255`	`queueKey string`
`256`	`256`	`eventRecorder events.Recorder`
`257`		`- queue workqueue.RateLimitingInterface`
	`257`	`+ queue workqueue.TypedRateLimitingInterface[any]`
`258`	`258`	`}`
`259`	`259`
`260`		`-func (c testSyncContext) Queue() workqueue.RateLimitingInterface {`
	`260`	`+func (c testSyncContext) Queue() workqueue.RateLimitingInterface { //nolint:staticcheck`
`261`	`261`	`return c.queue`
`262`	`262`	`}`
`263`	`263`
Original file line number	Diff line number	Diff line change
`@@ -154,6 +154,6 @@ func Test_updateStatusController(t *testing.T) {`
`154`	`154`	`func newTestSyncContextWithQueue() factory.SyncContext {`
`155`	`155`	`return testSyncContext{`
`156`	`156`	`eventRecorder: events.NewInMemoryRecorder("test"),`
`157`		`- queue: workqueue.NewRateLimitingQueue(workqueue.DefaultControllerRateLimiter()),`
	`157`	`+ queue: workqueue.NewTypedRateLimitingQueue(workqueue.DefaultTypedControllerRateLimiter[any]()),`
`158`	`158`	`}`
`159`	`159`	`}`