Refacter code to use new ObjectType

Problem: We currently use the variable objType
to refer to a client.Object's type (skeleton of
an object). We also use the variable obj to refer
to a full client.Object (object with fields filled
out). However, in many parts of the codebase these
two variables are used closely together and are
both of type client.Object which can be a little
confusing.

Solution: I created a new type called ObjectType
and refactored the codebase to utilize it.

Author: sarthyparty

internal/framework/controller/reconciler.go

@@ -13,6 +13,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 
 	"github.com/nginxinc/nginx-gateway-fabric/internal/framework/events"
+	ngftypes "github.com/nginxinc/nginx-gateway-fabric/internal/framework/types"
 )
 
 // NamespacedNameFilterFunc is a function that returns true if the resource should be processed by the reconciler.
@@ -24,7 +25,7 @@ type ReconcilerConfig struct {
 	// Getter gets a resource from the k8s API.
 	Getter Getter
 	// ObjectType is the type of the resource that the reconciler will reconcile.
-	ObjectType client.Object
+	ObjectType ngftypes.ObjectType
 	// EventCh is the channel where the reconciler will send events.
 	EventCh chan<- interface{}
 	// NamespacedNameFilter filters resources the controller will process. Can be nil.
@@ -52,7 +53,7 @@ func NewReconciler(cfg ReconcilerConfig) *Reconciler {
 	}
 }
 
-func (r *Reconciler) newObject(objectType client.Object) client.Object {
+func (r *Reconciler) newObject(objectType ngftypes.ObjectType) ngftypes.ObjectType {
 	if r.cfg.OnlyMetadata {
 		partialObj := &metav1.PartialObjectMetadata{}
 		partialObj.SetGroupVersionKind(objectType.GetObjectKind().GroupVersionKind())

internal/framework/controller/register.go

@@ -12,6 +12,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/predicate"
 
 	"github.com/nginxinc/nginx-gateway-fabric/internal/framework/controller/index"
+	ngftypes "github.com/nginxinc/nginx-gateway-fabric/internal/framework/types"
 )
 
 const (
@@ -82,7 +83,7 @@ func defaultConfig() config {
 // The registered controller will send events to the provided channel.
 func Register(
 	ctx context.Context,
-	objectType client.Object,
+	objectType ngftypes.ObjectType,
 	mgr manager.Manager,
 	eventCh chan<- interface{},
 	options ...Option,
@@ -137,7 +138,7 @@ func Register(
 func addIndex(
 	ctx context.Context,
 	indexer client.FieldIndexer,
-	objectType client.Object,
+	objectType ngftypes.ObjectType,
 	field string,
 	indexerFunc client.IndexerFunc,
 ) error {

internal/framework/controller/register_test.go

@@ -13,7 +13,6 @@ import (
 	"k8s.io/apimachinery/pkg/runtime/schema"
 	"k8s.io/apimachinery/pkg/types"
 	utilruntime "k8s.io/apimachinery/pkg/util/runtime"
-	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/client/fake"
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
 	v1 "sigs.k8s.io/gateway-api/apis/v1"
@@ -24,6 +23,7 @@ import (
 	"github.com/nginxinc/nginx-gateway-fabric/internal/framework/controller/index"
 	"github.com/nginxinc/nginx-gateway-fabric/internal/framework/controller/predicate"
 	"github.com/nginxinc/nginx-gateway-fabric/internal/framework/kinds"
+	ngftypes "github.com/nginxinc/nginx-gateway-fabric/internal/framework/types"
 )
 
 func TestRegister(t *testing.T) {
@@ -62,7 +62,7 @@ func TestRegister(t *testing.T) {
 
 	tests := []struct {
 		fakes                   fakes
-		objectType              client.Object
+		objectType              ngftypes.ObjectType
 		expectedErr             error
 		msg                     string
 		expectedMgrAddCallCount int

internal/framework/types/doc.go

@@ -0,0 +1,4 @@
+/*
+Package types contains types that are shared by the provisioner and static modes.
+*/
+package types

internal/framework/types/types.go

@@ -0,0 +1,6 @@
+package types
+
+import "sigs.k8s.io/controller-runtime/pkg/client"
+
+// ObjectType is used when we only care about the type of client.Object
+type ObjectType client.Object

internal/mode/provisioner/manager.go

@@ -21,6 +21,7 @@ import (
 	"github.com/nginxinc/nginx-gateway-fabric/internal/framework/events"
 	"github.com/nginxinc/nginx-gateway-fabric/internal/framework/gatewayclass"
 	"github.com/nginxinc/nginx-gateway-fabric/internal/framework/status"
+	ngftypes "github.com/nginxinc/nginx-gateway-fabric/internal/framework/types"
 )
 
 // Config is configuration for the provisioner mode.
@@ -63,7 +64,7 @@ func StartManager(cfg Config) error {
 	// Note: for any new object type or a change to the existing one,
 	// make sure to also update firstBatchPreparer creation below
 	controllerRegCfgs := []struct {
-		objectType client.Object
+		objectType ngftypes.ObjectType
 		options    []controller.Option
 	}{
 		{

internal/mode/static/manager.go

@@ -45,6 +45,7 @@ import (
 	"github.com/nginxinc/nginx-gateway-fabric/internal/framework/kinds"
 	"github.com/nginxinc/nginx-gateway-fabric/internal/framework/runnables"
 	"github.com/nginxinc/nginx-gateway-fabric/internal/framework/status"
+	ngftypes "github.com/nginxinc/nginx-gateway-fabric/internal/framework/types"
 	"github.com/nginxinc/nginx-gateway-fabric/internal/mode/static/config"
 	"github.com/nginxinc/nginx-gateway-fabric/internal/mode/static/metrics/collectors"
 	ngxcfg "github.com/nginxinc/nginx-gateway-fabric/internal/mode/static/nginx/config"
@@ -356,7 +357,7 @@ func registerControllers(
 	controlConfigNSName types.NamespacedName,
 ) error {
 	type ctlrCfg struct {
-		objectType client.Object
+		objectType ngftypes.ObjectType
 		options    []controller.Option
 	}
 

internal/mode/static/state/store.go

@@ -9,21 +9,22 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	"github.com/nginxinc/nginx-gateway-fabric/internal/framework/kinds"
+	ngftypes "github.com/nginxinc/nginx-gateway-fabric/internal/framework/types"
 	"github.com/nginxinc/nginx-gateway-fabric/internal/mode/static/policies"
 	"github.com/nginxinc/nginx-gateway-fabric/internal/mode/static/state/graph"
 )
 
 // Updater updates the cluster state.
 type Updater interface {
 	Upsert(obj client.Object)
-	Delete(objType client.Object, nsname types.NamespacedName)
+	Delete(objType ngftypes.ObjectType, nsname types.NamespacedName)
 }
 
 // objectStore is a store of client.Object
 type objectStore interface {
-	get(objType client.Object, nsname types.NamespacedName) client.Object
+	get(objType ngftypes.ObjectType, nsname types.NamespacedName) client.Object
 	upsert(obj client.Object)
-	delete(objType client.Object, nsname types.NamespacedName)
+	delete(objType ngftypes.ObjectType, nsname types.NamespacedName)
 }
 
 // ngfPolicyObjectStore is a store of policies.Policy.
@@ -44,7 +45,7 @@ func newNGFPolicyObjectStore(
 	}
 }
 
-func (p *ngfPolicyObjectStore) get(objType client.Object, nsname types.NamespacedName) client.Object {
+func (p *ngfPolicyObjectStore) get(objType ngftypes.ObjectType, nsname types.NamespacedName) client.Object {
 	key := graph.PolicyKey{
 		NsName: nsname,
 		GVK:    p.extractGVKFunc(objType),
@@ -67,7 +68,7 @@ func (p *ngfPolicyObjectStore) upsert(obj client.Object) {
 	p.policies[key] = pol
 }
 
-func (p *ngfPolicyObjectStore) delete(objType client.Object, nsname types.NamespacedName) {
+func (p *ngfPolicyObjectStore) delete(objType ngftypes.ObjectType, nsname types.NamespacedName) {
 	key := graph.PolicyKey{
 		NsName: nsname,
 		GVK:    p.extractGVKFunc(objType),
@@ -88,7 +89,7 @@ func newObjectStoreMapAdapter[T client.Object](objects map[types.NamespacedName]
 	}
 }
 
-func (m *objectStoreMapAdapter[T]) get(_ client.Object, nsname types.NamespacedName) client.Object {
+func (m *objectStoreMapAdapter[T]) get(_ ngftypes.ObjectType, nsname types.NamespacedName) client.Object {
 	obj, exist := m.objects[nsname]
 	if !exist {
 		return nil
@@ -105,7 +106,7 @@ func (m *objectStoreMapAdapter[T]) upsert(obj client.Object) {
 	m.objects[client.ObjectKeyFromObject(obj)] = t
 }
 
-func (m *objectStoreMapAdapter[T]) delete(_ client.Object, nsname types.NamespacedName) {
+func (m *objectStoreMapAdapter[T]) delete(_ ngftypes.ObjectType, nsname types.NamespacedName) {
 	delete(m.objects, nsname)
 }
 
@@ -150,15 +151,15 @@ func (m *multiObjectStore) mustFindStoreForObj(obj client.Object) objectStore {
 	return store
 }
 
-func (m *multiObjectStore) get(objType client.Object, nsname types.NamespacedName) client.Object {
+func (m *multiObjectStore) get(objType ngftypes.ObjectType, nsname types.NamespacedName) client.Object {
 	return m.mustFindStoreForObj(objType).get(objType, nsname)
 }
 
 func (m *multiObjectStore) upsert(obj client.Object) {
 	m.mustFindStoreForObj(obj).upsert(obj)
 }
 
-func (m *multiObjectStore) delete(objType client.Object, nsname types.NamespacedName) {
+func (m *multiObjectStore) delete(objType ngftypes.ObjectType, nsname types.NamespacedName) {
 	m.mustFindStoreForObj(objType).delete(objType, nsname)
 }
 
@@ -257,7 +258,7 @@ func (s *changeTrackingUpdater) Upsert(obj client.Object) {
 	s.setChangeType(obj, changingUpsert)
 }
 
-func (s *changeTrackingUpdater) delete(objType client.Object, nsname types.NamespacedName) (changed bool) {
+func (s *changeTrackingUpdater) delete(objType ngftypes.ObjectType, nsname types.NamespacedName) (changed bool) {
 	objTypeGVK := s.extractGVK(objType)
 
 	if s.store.persists(objTypeGVK) {
@@ -276,7 +277,7 @@ func (s *changeTrackingUpdater) delete(objType client.Object, nsname types.Names
 	return stateChanged.delete(objType, nsname)
 }
 
-func (s *changeTrackingUpdater) Delete(objType client.Object, nsname types.NamespacedName) {
+func (s *changeTrackingUpdater) Delete(objType ngftypes.ObjectType, nsname types.NamespacedName) {
 	s.assertSupportedGVK(s.extractGVK(objType))
 
 	changingDelete := s.delete(objType, nsname)