raname hooks to handlers

Author: mjudeikis

apiexport/provider.go

@@ -42,7 +42,7 @@ import (
 
 	apisv1alpha1 "github.com/kcp-dev/sdk/apis/apis/v1alpha1"
 
-	"github.com/kcp-dev/multicluster-provider/internal/hooks"
+	"github.com/kcp-dev/multicluster-provider/internal/handlers"
 	"github.com/kcp-dev/multicluster-provider/internal/provider"
 )
 
@@ -61,8 +61,8 @@ type Provider struct {
 	providersLock sync.RWMutex
 	providers     map[string]*provider.Provider
 
-	log   logr.Logger
-	hooks hooks.Hooks
+	log      logr.Logger
+	handlers handlers.Handlers
 
 	config *rest.Config
 	scheme *runtime.Scheme
@@ -88,9 +88,9 @@ type Options struct {
 	// the same endpoint semantics.
 	ObjectToWatch client.Object
 
-	// Hooks are lifecycle hook, ran for each logical cluster in the provider represented
+	// Handlers are lifecycle handlers, ran for each logical cluster in the provider represented
 	// by apibinding object.
-	Hooks hooks.Hooks
+	Handlers handlers.Handlers
 }
 
 // New creates a new kcp virtual workspace provider. The provided [rest.Config]
@@ -133,8 +133,8 @@ func New(cfg *rest.Config, endpointSliceName string, options Options) (*Provider
 		object: options.ObjectToWatch,
 		cache:  c,
 
-		log:   *options.Log,
-		hooks: options.Hooks,
+		log:      *options.Log,
+		handlers: options.Handlers,
 	}, nil
 }
 
@@ -239,7 +239,7 @@ func (p *Provider) update(es *apisv1alpha1.APIExportEndpointSlice) {
 			ObjectToWatch: p.object,
 			Scheme:        p.scheme,
 			Log:           &logger,
-			Hooks:         p.hooks,
+			Handlers:      p.handlers,
 		})
 		if err != nil {
 			p.log.Error(err, "failed to create provider")

internal/hooks/hooks.go internal/handlers/handlers.gointernal/hooks/hooks.go renamed to internal/handlers/handlers.go

@@ -14,20 +14,20 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package hooks
+package handlers
 
 import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 )
 
-// Hooks is a collection of Hook.
-type Hooks []Hook
+// Handlers is a collection of Handler.
+type Handlers []Handler
 
-// Hook are lifecycle hook for logical clusters managed by a provider and presented as
+// Handler are lifecycle hook for logical clusters managed by a provider and presented as
 // apibindings via APIExport virtual workspace.
 // It allows to react to addition, update and deletion of apibindings (consumers) in the provider.
-// Hooks should be implemented with care to avoid blocking the main reconciliation loop.
-type Hook interface {
+// Handlers should be implemented with care to avoid blocking the main reconciliation loop.
+type Handler interface {
 	// OnAdd is called when a new logical cluster is added.
 	OnAdd(obj client.Object)
 
@@ -38,23 +38,23 @@ type Hook interface {
 	OnDelete(obj client.Object)
 }
 
-// RunOnAdd runs OnAdd on all hooks.
-func (h Hooks) RunOnAdd(obj client.Object) {
-	for _, hook := range h {
-		hook.OnAdd(obj)
+// RunOnAdd runs OnAdd on all handlers.
+func (h Handlers) RunOnAdd(obj client.Object) {
+	for _, handler := range h {
+		handler.OnAdd(obj)
 	}
 }
 
-// RunOnUpdate runs OnUpdate on all hooks.
-func (h Hooks) RunOnUpdate(oldObj, newObj client.Object) {
-	for _, hook := range h {
-		hook.OnUpdate(oldObj, newObj)
+// RunOnUpdate runs OnUpdate on all handlers.
+func (h Handlers) RunOnUpdate(oldObj, newObj client.Object) {
+	for _, handler := range h {
+		handler.OnUpdate(oldObj, newObj)
 	}
 }
 
-// RunOnDelete runs OnDelete on all hooks.
-func (h Hooks) RunOnDelete(obj client.Object) {
-	for _, hook := range h {
-		hook.OnDelete(obj)
+// RunOnDelete runs OnDelete on all handlers.
+func (h Handlers) RunOnDelete(obj client.Object) {
+	for _, handler := range h {
+		handler.OnDelete(obj)
 	}
 }

internal/provider/provider.go

@@ -44,7 +44,7 @@ import (
 
 	mcpcache "github.com/kcp-dev/multicluster-provider/internal/cache"
 	mcrecorder "github.com/kcp-dev/multicluster-provider/internal/events/recorder"
-	"github.com/kcp-dev/multicluster-provider/internal/hooks"
+	"github.com/kcp-dev/multicluster-provider/internal/handlers"
 )
 
 // Clusters is an alias for clusters.Clusters[cluster.Cluster].
@@ -68,7 +68,7 @@ type Provider struct {
 	aware     multicluster.Aware
 	clusters  *Clusters
 	cancelFns map[logicalcluster.Name]context.CancelFunc
-	hooks     hooks.Hooks
+	handlers  handlers.Handlers
 
 	recorderProvider *mcrecorder.Provider
 }
@@ -85,7 +85,7 @@ type Options struct {
 
 	// ObjectToWatch is the object type that the provider watches via a /clusters/*
 	// wildcard endpoint to extract information about logical clusters joining and
-	// leaving the "fleet" of (logical) clusters in kcp. If this is nil, it defaults
+	// leaving the "fleet" of (logical) clustergit pushs in kcp. If this is nil, it defaults
 	// to [apisv1alpha1.APIBinding]. This might be useful when using this provider
 	// against custom virtual workspaces that are not the APIExport one but share
 	// the same endpoint semantics.
@@ -100,9 +100,9 @@ type Options struct {
 	// stopped with the manager.
 	makeBroadcaster mcrecorder.EventBroadcasterProducer
 
-	// Hooks are lifecycle hooks for logical clusters managed by this provider represented
+	// Handlers are lifecycle handlers for logical clusters managed by this provider represented
 	// by apibinding object.
-	Hooks hooks.Hooks
+	Handlers handlers.Handlers
 }
 
 // New creates a new kcp virtual workspace provider. The provided [rest.Config]
@@ -148,12 +148,12 @@ func New(cfg *rest.Config, clusters *Clusters, options Options) (*Provider, erro
 	}
 
 	return &Provider{
-		config: cfg,
-		scheme: options.Scheme,
-		cache:  options.WildcardCache,
-		object: options.ObjectToWatch,
-		hooks:  options.Hooks,
-		log:    *options.Log,
+		config:   cfg,
+		scheme:   options.Scheme,
+		cache:    options.WildcardCache,
+		object:   options.ObjectToWatch,
+		handlers: options.Handlers,
+		log:      *options.Log,
 
 		cancelFns: map[logicalcluster.Name]context.CancelFunc{},
 		clusters:  clusters,
@@ -206,15 +206,15 @@ func (p *Provider) Start(ctx context.Context, aware multicluster.Aware) error {
 				return
 			}
 			p.cancelFns[clusterName] = cancel
-			p.hooks.RunOnAdd(cobj)
+			p.handlers.RunOnAdd(cobj)
 		},
 		UpdateFunc: func(oldObj, newObj interface{}) {
 			cobj, ok := newObj.(client.Object)
 			if !ok {
 				klog.Errorf("unexpected object type %T", newObj)
 				return
 			}
-			p.hooks.RunOnUpdate(oldObj.(client.Object), cobj)
+			p.handlers.RunOnUpdate(oldObj.(client.Object), cobj)
 		},
 		DeleteFunc: func(obj any) {
 			cobj, ok := obj.(client.Object)
@@ -253,7 +253,7 @@ func (p *Provider) Start(ctx context.Context, aware multicluster.Aware) error {
 					cancel()
 					delete(p.cancelFns, clusterName)
 					p.clusters.Remove(clusterName.String())
-					p.hooks.RunOnDelete(cobj)
+					p.handlers.RunOnDelete(cobj)
 				}
 			}
 		},

path-aware/provider.go

@@ -29,13 +29,13 @@ import (
 	kcpcore "github.com/kcp-dev/sdk/apis/core"
 
 	provider "github.com/kcp-dev/multicluster-provider/apiexport"
-	"github.com/kcp-dev/multicluster-provider/internal/hooks"
+	"github.com/kcp-dev/multicluster-provider/internal/handlers"
 	"github.com/kcp-dev/multicluster-provider/internal/paths"
 )
 
 var _ multicluster.Provider = &Provider{}
 var _ multicluster.ProviderRunnable = &Provider{}
-var _ hooks.Hook = &pathHook{}
+var _ handlers.Handler = &pathHandler{}
 
 // Provider is a [sigs.k8s.io/multicluster-runtime/pkg/multicluster.Provider] that represents each [logical cluster]
 // (in the kcp sense) exposed via a APIExport virtual workspace as a cluster in the [sigs.k8s.io/multicluster-runtime] sense.
@@ -55,10 +55,10 @@ type Provider struct {
 func New(cfg *rest.Config, endpointSliceName string, options provider.Options) (*Provider, error) {
 	store := paths.New()
 
-	h := &pathHook{
+	h := &pathHandler{
 		pathStore: store,
 	}
-	options.Hooks = append(options.Hooks, h)
+	options.Handlers = append(options.Handlers, h)
 
 	p, err := provider.New(cfg, endpointSliceName, options)
 	if err != nil {
@@ -91,11 +91,11 @@ func (p *Provider) Start(ctx context.Context, aware multicluster.Aware) error {
 	return p.Provider.Start(ctx, aware)
 }
 
-type pathHook struct {
+type pathHandler struct {
 	pathStore *paths.Store
 }
 
-func (p *pathHook) OnAdd(obj client.Object) {
+func (p *pathHandler) OnAdd(obj client.Object) {
 	cluster := logicalcluster.From(obj)
 
 	path := obj.GetAnnotations()[kcpcore.LogicalClusterPathAnnotationKey]
@@ -106,11 +106,11 @@ func (p *pathHook) OnAdd(obj client.Object) {
 	p.pathStore.Add(path, cluster)
 }
 
-func (p *pathHook) OnUpdate(oldObj, newObj client.Object) {
+func (p *pathHandler) OnUpdate(oldObj, newObj client.Object) {
 	// Not used.
 }
 
-func (p *pathHook) OnDelete(obj client.Object) {
+func (p *pathHandler) OnDelete(obj client.Object) {
 	path, ok := obj.GetAnnotations()[kcpcore.LogicalClusterPathAnnotationKey]
 	if !ok {
 		return