SQUASH: remove logical.Name alias

Signed-off-by: Dr. Stefan Schimanski <[email protected]>

Author: sttts

examples/fleet/main.go

@@ -21,7 +21,6 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/manager/signals"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 	kind "sigs.k8s.io/kind/pkg/cluster"
-	"sigs.k8s.io/logical-cluster"
 )
 
 func init() {
@@ -63,7 +62,7 @@ func main() {
 		func(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
 			log := log.FromContext(ctx)
 
-			cluster, err := mgr.GetCluster(ctx, req.Cluster)
+			cluster, err := mgr.GetCluster(ctx, req.ClusterName)
 			if err != nil {
 				return reconcile.Result{}, err
 			}
@@ -97,9 +96,9 @@ func main() {
 // KindClusterProvider is a cluster provider that works with a local Kind instance.
 type KindClusterProvider struct{}
 
-func (k *KindClusterProvider) Get(ctx context.Context, name logical.Name, opts ...cluster.Option) (cluster.Cluster, error) {
+func (k *KindClusterProvider) Get(ctx context.Context, clusterName string, opts ...cluster.Option) (cluster.Cluster, error) {
 	provider := kind.NewProvider()
-	kubeconfig, err := provider.KubeConfig(string(name), false)
+	kubeconfig, err := provider.KubeConfig(clusterName, false)
 	if err != nil {
 		return nil, err
 	}
@@ -111,18 +110,18 @@ func (k *KindClusterProvider) Get(ctx context.Context, name logical.Name, opts .
 	return cluster.New(cfg, opts...)
 }
 
-func (k *KindClusterProvider) List() ([]logical.Name, error) {
+func (k *KindClusterProvider) List() ([]string, error) {
 	provider := kind.NewProvider()
 	list, err := provider.List()
 	if err != nil {
 		return nil, err
 	}
-	res := make([]logical.Name, 0, len(list))
+	res := make([]string, 0, len(list))
 	for _, cluster := range list {
 		if !strings.HasPrefix(cluster, "fleet-") {
 			continue
 		}
-		res = append(res, logical.Name(cluster))
+		res = append(res, cluster)
 	}
 	return res, nil
 }
@@ -169,8 +168,8 @@ func (k *KindWatcher) ResultChan() <-chan cluster.WatchEvent {
 							continue
 						}
 						k.ch <- cluster.WatchEvent{
-							Type: watch.Added,
-							Name: logical.Name(cl),
+							Type:        watch.Added,
+							ClusterName: cl,
 						}
 					}
 					// Check for deleted clusters.
@@ -179,8 +178,8 @@ func (k *KindWatcher) ResultChan() <-chan cluster.WatchEvent {
 							continue
 						}
 						k.ch <- cluster.WatchEvent{
-							Type: watch.Deleted,
-							Name: logical.Name(cl),
+							Type:        watch.Deleted,
+							ClusterName: cl,
 						}
 					}
 					set = newSet

go.mod

@@ -27,7 +27,6 @@ require (
 	k8s.io/component-base v0.28.3
 	k8s.io/klog/v2 v2.110.1
 	k8s.io/utils v0.0.0-20230406110748-d93618cff8a2
-	sigs.k8s.io/logical-cluster v0.0.1-alpha.0
 	sigs.k8s.io/yaml v1.4.0
 )
 

go.sum

@@ -653,8 +653,6 @@ sigs.k8s.io/apiserver-network-proxy/konnectivity-client v0.1.2 h1:trsWhjU5jZrx6U
 sigs.k8s.io/apiserver-network-proxy/konnectivity-client v0.1.2/go.mod h1:+qG7ISXqCDVVcyO8hLn12AKVYYUjM7ftlqsqmrhMZE0=
 sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd h1:EDPBXCAspyGV4jQlpZSudPeMmr1bNJefnuqLsRAsHZo=
 sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd/go.mod h1:B8JuhiUyNFVKdsE8h686QcCxMaH6HrOAZj4vswFpcB0=
-sigs.k8s.io/logical-cluster v0.0.1-alpha.0 h1:vigMG0I1fgDVn0hsTOeZB55AmplXC7D4iLa60qeyX70=
-sigs.k8s.io/logical-cluster v0.0.1-alpha.0/go.mod h1:7YymTkuUFI+tkwCRPMsk+TiyBQiPDKRArxVAAGpezZI=
 sigs.k8s.io/structured-merge-diff/v4 v4.2.3 h1:PRbqxJClWWYMNV1dhaG4NsibJbArud9kFxnAMREiWFE=
 sigs.k8s.io/structured-merge-diff/v4 v4.2.3/go.mod h1:qjx8mGObPmV2aSZepjQjbmb2ihdVs8cGKBraizNC69E=
 sigs.k8s.io/yaml v1.4.0 h1:Mk1wCc2gy/F0THH0TAp1QYyJNzRm2KCLy3o5ASXVI5E=

pkg/builder/controller.go

@@ -36,7 +36,6 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/predicate"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 	"sigs.k8s.io/controller-runtime/pkg/source"
-	"sigs.k8s.io/logical-cluster"
 )
 
 // Supporting mocking out functions for testing.
@@ -61,7 +60,7 @@ type Builder struct {
 	watchesInput     []WatchesInput
 	mgr              manager.Manager
 	cluster          cluster.Cluster
-	logicalName      logical.Name
+	clusterName      string
 	globalPredicates []predicate.Predicate
 	ctrl             controller.Controller
 	ctrlOptions      controller.Options
@@ -337,7 +336,7 @@ func (blder *Builder) doWatch() error {
 			// given that the cache cannot be validated to be coming from the same cluter.
 			// In the future, we could consider allowing this by satisfying a new interface
 			// that sets and uses the cluster.
-			if blder.logicalName != "" {
+			if blder.clusterName != "" {
 				return fmt.Errorf("when using a logical adapter, custom raw watches %T are not allowed", w.src)
 			}
 		}

pkg/builder/controller_test.go

@@ -46,7 +46,6 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/predicate"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 	"sigs.k8s.io/controller-runtime/pkg/scheme"
-	"sigs.k8s.io/logical-cluster"
 )
 
 type typedNoop struct{}
@@ -562,7 +561,7 @@ var _ = Describe("application", func() {
 	Context("with logical adapter", func() {
 		It("should support watching across clusters", func() {
 			adapter := &fakeClusterProvider{
-				list: []logical.Name{
+				clusterNameList: []string{
 					"cluster1",
 					"cluster2",
 				},
@@ -602,7 +601,7 @@ var _ = Describe("application", func() {
 						}
 
 						defer GinkgoRecover()
-						switch req.Cluster {
+						switch req.ClusterName {
 						case "cluster1":
 							ch1 <- req
 						case "cluster2":
@@ -645,14 +644,14 @@ var _ = Describe("application", func() {
 					Name:      dep.Name,
 					Namespace: dep.Namespace,
 				},
-				Cluster: "cluster1",
+				ClusterName: "cluster1",
 			})))
 			Eventually(ch2).Should(Receive(Equal(reconcile.Request{
 				NamespacedName: types.NamespacedName{
 					Name:      dep.Name,
 					Namespace: dep.Namespace,
 				},
-				Cluster: "cluster2",
+				ClusterName: "cluster2",
 			})))
 
 			By("Creating a ReplicaSet")
@@ -686,14 +685,14 @@ var _ = Describe("application", func() {
 					Name:      dep.Name,
 					Namespace: dep.Namespace,
 				},
-				Cluster: "cluster1",
+				ClusterName: "cluster1",
 			})))
 			Eventually(ch2).Should(Receive(Equal(reconcile.Request{
 				NamespacedName: types.NamespacedName{
 					Name:      dep.Name,
 					Namespace: dep.Namespace,
 				},
-				Cluster: "cluster2",
+				ClusterName: "cluster2",
 			})))
 		})
 	})
@@ -838,18 +837,18 @@ func (*fakeType) GetObjectKind() schema.ObjectKind { return nil }
 func (*fakeType) DeepCopyObject() runtime.Object   { return nil }
 
 type fakeClusterProvider struct {
-	list    []logical.Name
-	listErr error
+	clusterNameList []string
+	listErr         error
 
 	watch chan cluster.WatchEvent
 }
 
-func (f *fakeClusterProvider) Get(ctx context.Context, name logical.Name, opts ...cluster.Option) (cluster.Cluster, error) {
+func (f *fakeClusterProvider) Get(ctx context.Context, clusterName string, opts ...cluster.Option) (cluster.Cluster, error) {
 	return cluster.New(testenv.Config, opts...)
 }
 
-func (f *fakeClusterProvider) List() ([]logical.Name, error) {
-	return f.list, f.listErr
+func (f *fakeClusterProvider) List() ([]string, error) {
+	return f.clusterNameList, f.listErr
 }
 
 func (f *fakeClusterProvider) Watch() (cluster.Watcher, error) {

pkg/cluster/cluster.go

@@ -28,8 +28,6 @@ import (
 	"k8s.io/client-go/kubernetes/scheme"
 	"k8s.io/client-go/rest"
 	"k8s.io/client-go/tools/record"
-	"sigs.k8s.io/logical-cluster"
-
 	"sigs.k8s.io/controller-runtime/pkg/cache"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/client/apiutil"
@@ -66,13 +64,13 @@ type AwareDeepCopy[T any] interface {
 	DeepCopyFor(Cluster) T
 }
 
-// LogicalGetterFunc is a function that returns a cluster for a given logical cluster name.
-type LogicalGetterFunc func(context.Context, logical.Name) (Cluster, error)
+// ByNameGetterFunc is a function that returns a cluster for a given logical cluster name.
+type ByNameGetterFunc func(ctx context.Context, clusterName string) (Cluster, error)
 
 // Cluster provides various methods to interact with a cluster.
 type Cluster interface {
-	// Name returns the unique logical name of the cluster.
-	Name() logical.Name
+	// Name returns the identifying name of the cluster.
+	Name() string
 
 	// GetHTTPClient returns an HTTP client that can be used to talk to the apiserver
 	GetHTTPClient() *http.Client
@@ -112,8 +110,8 @@ type Cluster interface {
 
 // Options are the possible options that can be configured for a Cluster.
 type Options struct {
-	// Name is the unique name of the cluster.
-	Name logical.Name
+	// Name is the identifying name of the cluster.
+	Name string
 
 	// Scheme is the scheme used to resolve runtime.Objects to GroupVersionKinds / Resources
 	// Defaults to the kubernetes/client-go scheme.Scheme, but it's almost always better
@@ -196,7 +194,7 @@ func New(config *rest.Config, opts ...Option) (Cluster, error) {
 	if config == nil {
 		return nil, errors.New("must specify Config")
 	}
-	
+
 	config = rest.CopyConfig(config)
 	if config.UserAgent == "" {
 		config.UserAgent = rest.DefaultKubernetesUserAgent()
@@ -354,7 +352,7 @@ func setOptionsDefaults(options Options, config *rest.Config) (Options, error) {
 }
 
 // WithName sets the name of the cluster.
-func WithName(name logical.Name) Option {
+func WithName(name string) Option {
 	return func(o *Options) {
 		if o.Name != "" {
 			panic("cluster name cannot be set more than once")

pkg/cluster/internal.go

@@ -29,11 +29,10 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/cache"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	intrec "sigs.k8s.io/controller-runtime/pkg/internal/recorder"
-	"sigs.k8s.io/logical-cluster"
 )
 
 type cluster struct {
-	name logical.Name
+	name string
 
 	// config is the rest.config used to talk to the apiserver.  Required.
 	config *rest.Config
@@ -62,7 +61,7 @@ type cluster struct {
 	logger logr.Logger
 }
 
-func (c *cluster) Name() logical.Name {
+func (c *cluster) Name() string {
 	return c.name
 }
 

pkg/cluster/provider.go

@@ -4,7 +4,6 @@ import (
 	"context"
 
 	"k8s.io/apimachinery/pkg/watch"
-	"sigs.k8s.io/logical-cluster"
 )
 
 // Provider defines methods to retrieve, list, and watch fleet of clusters.
@@ -15,12 +14,12 @@ import (
 // clusters that are backed by Cluster API resources, which can live
 // in multiple namespaces in a single management cluster.
 type Provider interface {
-	Get(ctx context.Context, name logical.Name, opts ...Option) (Cluster, error)
+	Get(ctx context.Context, clusterName string, opts ...Option) (Cluster, error)
 
 	// List returns a list of logical clusters.
 	// This method is used to discover the initial set of logical clusters
 	// and to refresh the list of logical clusters periodically.
-	List() ([]logical.Name, error)
+	List() ([]string, error)
 
 	// Watch returns a Watcher that watches for changes to a list of logical clusters
 	// and react to potential changes.
@@ -54,6 +53,6 @@ type WatchEvent struct {
 	// 		A periodic event is sent that contains no new data: ignored.
 	Type watch.EventType
 
-	// Name is the name of the logical cluster related to the event.
-	Name logical.Name
+	// ClusterName is the name of the cluster related to the event.
+	ClusterName string
 }

pkg/handler/enqueue.go

@@ -25,7 +25,6 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/event"
 	logf "sigs.k8s.io/controller-runtime/pkg/internal/log"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
-	"sigs.k8s.io/logical-cluster"
 )
 
 var enqueueLog = logf.RuntimeLog.WithName("eventhandler").WithName("EnqueueRequestForObject")
@@ -47,12 +46,12 @@ func (e *EnqueueRequestForObject) Create(ctx context.Context, evt event.CreateEv
 		enqueueLog.Error(nil, "CreateEvent received with no metadata", "event", evt)
 		return
 	}
-	var logicalClusterName logical.Name
+	var clusterName string
 	if e.cluster != nil {
-		logicalClusterName = e.cluster.Name()
+		clusterName = e.cluster.Name()
 	}
 	q.Add(reconcile.Request{
-		Cluster: logicalClusterName,
+		ClusterName: clusterName,
 		NamespacedName: types.NamespacedName{
 			Name:      evt.Object.GetName(),
 			Namespace: evt.Object.GetNamespace(),
@@ -62,23 +61,23 @@ func (e *EnqueueRequestForObject) Create(ctx context.Context, evt event.CreateEv
 
 // Update implements EventHandler.
 func (e *EnqueueRequestForObject) Update(ctx context.Context, evt event.UpdateEvent, q workqueue.RateLimitingInterface) {
-	var logicalClusterName logical.Name
+	var clusterName string
 	if e.cluster != nil {
-		logicalClusterName = e.cluster.Name()
+		clusterName = e.cluster.Name()
 	}
 
 	switch {
 	case evt.ObjectNew != nil:
 		q.Add(reconcile.Request{
-			Cluster: logicalClusterName,
+			ClusterName: clusterName,
 			NamespacedName: types.NamespacedName{
 				Name:      evt.ObjectNew.GetName(),
 				Namespace: evt.ObjectNew.GetNamespace(),
 			},
 		})
 	case evt.ObjectOld != nil:
 		q.Add(reconcile.Request{
-			Cluster: logicalClusterName,
+			ClusterName: clusterName,
 			NamespacedName: types.NamespacedName{
 				Name:      evt.ObjectOld.GetName(),
 				Namespace: evt.ObjectOld.GetNamespace(),
@@ -95,12 +94,12 @@ func (e *EnqueueRequestForObject) Delete(ctx context.Context, evt event.DeleteEv
 		enqueueLog.Error(nil, "DeleteEvent received with no metadata", "event", evt)
 		return
 	}
-	var logicalClusterName logical.Name
+	var clusterName string
 	if e.cluster != nil {
-		logicalClusterName = e.cluster.Name()
+		clusterName = e.cluster.Name()
 	}
 	q.Add(reconcile.Request{
-		Cluster: logicalClusterName,
+		ClusterName: clusterName,
 		NamespacedName: types.NamespacedName{
 			Name:      evt.Object.GetName(),
 			Namespace: evt.Object.GetNamespace(),
@@ -114,12 +113,12 @@ func (e *EnqueueRequestForObject) Generic(ctx context.Context, evt event.Generic
 		enqueueLog.Error(nil, "GenericEvent received with no metadata", "event", evt)
 		return
 	}
-	var logicalClusterName logical.Name
+	var clusterName string
 	if e.cluster != nil {
-		logicalClusterName = e.cluster.Name()
+		clusterName = e.cluster.Name()
 	}
 	q.Add(reconcile.Request{
-		Cluster: logicalClusterName,
+		ClusterName: clusterName,
 		NamespacedName: types.NamespacedName{
 			Name:      evt.Object.GetName(),
 			Namespace: evt.Object.GetNamespace(),