group libctrl into a set of packages

Author: ecordell

adopt/adopt.go

@@ -30,9 +30,10 @@ import (
 	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/klog/v2"
 
-	"github.com/authzed/controller-idioms"
 	"github.com/authzed/controller-idioms/handler"
+	"github.com/authzed/controller-idioms/queue"
 	"github.com/authzed/controller-idioms/typed"
+	"github.com/authzed/controller-idioms/typedctx"
 )
 
 // TODO: a variant where there can only be one owner (label only, fail if labelled for someone else)
@@ -64,7 +65,7 @@ type IndexKeyFunc func(ctx context.Context) (indexName string, indexValue string
 const Owned = "owned"
 
 type AdoptionHandler[K Object, A Adoptable[A]] struct {
-	libctrl.HandlerControlContext
+	queue.OperationsContext
 
 	// ControllerFieldManager is the value to use when adopting the object
 	// for visibility by the controller
@@ -76,13 +77,13 @@ type AdoptionHandler[K Object, A Adoptable[A]] struct {
 	ControllerFieldManager string
 
 	// AdopteeCtx tells the handler how to fetch the adoptee from context
-	AdopteeCtx libctrl.MustValueContext[types.NamespacedName]
+	AdopteeCtx typedctx.MustValueContext[types.NamespacedName]
 
 	// OwnerCtx tells the handler how to fetch the owner from context
-	OwnerCtx libctrl.MustValueContext[types.NamespacedName]
+	OwnerCtx typedctx.MustValueContext[types.NamespacedName]
 
 	// AdoptedCtx will store the object after it has been adopted
-	AdoptedCtx libctrl.SettableContext[K]
+	AdoptedCtx typedctx.SettableContext[K]
 
 	// ObjectAdoptedFunc is called when an adoption was performed
 	ObjectAdoptedFunc func(ctx context.Context, obj K)

adopt/owners.go

@@ -11,8 +11,8 @@ import (
 // OwnerKeysFromMeta returns a set of namespace/name keys for the owners
 // of adopted objects with `annotationPrefix`. The namespace is always set
 // to the namespace of the object passed in.
-func OwnerKeysFromMeta(annotationPrefix string) func(in interface{}) ([]string, error) {
-	return func(in interface{}) ([]string, error) {
+func OwnerKeysFromMeta(annotationPrefix string) func(in any) ([]string, error) {
+	return func(in any) ([]string, error) {
 		obj := in.(runtime.Object)
 		objMeta, err := meta.Accessor(obj)
 		if err != nil {

component.go renamed to component/component.go

@@ -1,4 +1,4 @@
-package libctrl
+package component
 
 import (
 	"context"
@@ -9,6 +9,7 @@ import (
 	"k8s.io/apimachinery/pkg/runtime"
 	utilruntime "k8s.io/apimachinery/pkg/util/runtime"
 
+	"github.com/authzed/controller-idioms/hash"
 	"github.com/authzed/controller-idioms/typed"
 )
 
@@ -61,11 +62,11 @@ func (c *Component[K]) List(ctx context.Context, indexValue fmt.Stringer) (out [
 // previous configuration the controller wrote
 type HashableComponent[K KubeObject] struct {
 	*Component[K]
-	ObjectHasher
+	hash.ObjectHasher
 	HashAnnotationKey string
 }
 
-func NewHashableComponent[K KubeObject](component *Component[K], hasher ObjectHasher, key string) *HashableComponent[K] {
+func NewHashableComponent[K KubeObject](component *Component[K], hasher hash.ObjectHasher, key string) *HashableComponent[K] {
 	return &HashableComponent[K]{
 		Component:         component,
 		ObjectHasher:      hasher,

component/component_handler.go

@@ -0,0 +1,33 @@
+package component
+
+import (
+	"context"
+
+	"k8s.io/apimachinery/pkg/types"
+
+	"github.com/authzed/controller-idioms/handler"
+	"github.com/authzed/controller-idioms/typedctx"
+)
+
+// ContextHandler fills the value for a Key with the result of
+// fetching a component.
+type ContextHandler[K KubeObject] struct {
+	owner     typedctx.MustValueContext[types.NamespacedName]
+	ctxKey    typedctx.SettableContext[[]K]
+	component *Component[K]
+	next      handler.ContextHandler
+}
+
+func NewComponentContextHandler[K KubeObject](contextKey typedctx.SettableContext[[]K], component *Component[K], owner typedctx.MustValueContext[types.NamespacedName], next handler.ContextHandler) *ContextHandler[K] {
+	return &ContextHandler[K]{
+		owner:     owner,
+		ctxKey:    contextKey,
+		component: component,
+		next:      next,
+	}
+}
+
+func (h *ContextHandler[K]) Handle(ctx context.Context) {
+	ctx = h.ctxKey.WithValue(ctx, h.component.List(ctx, h.owner.MustValue(ctx)))
+	h.next.Handle(ctx)
+}

ensure_component.go renamed to component/ensure_component.go

@@ -1,4 +1,4 @@
-package libctrl
+package component
 
 import (
 	"context"
@@ -8,6 +8,8 @@ import (
 	applycorev1 "k8s.io/client-go/applyconfigurations/core/v1"
 
 	"github.com/authzed/controller-idioms/handler"
+	"github.com/authzed/controller-idioms/queue"
+	"github.com/authzed/controller-idioms/typedctx"
 )
 
 type Annotator[T any] interface {
@@ -16,8 +18,8 @@ type Annotator[T any] interface {
 
 type EnsureComponentByHash[K KubeObject, A Annotator[A]] struct {
 	*HashableComponent[K]
-	ctrls        *ContextKey[ControlAll]
-	nn           MustValueContext[types.NamespacedName]
+	ctrls        *typedctx.Key[queue.Interface]
+	nn           typedctx.MustValueContext[types.NamespacedName]
 	applyObject  func(ctx context.Context, apply A) (K, error)
 	deleteObject func(ctx context.Context, nn types.NamespacedName) error
 	newObj       func(ctx context.Context) A
@@ -27,8 +29,8 @@ var _ handler.ContextHandler = &EnsureComponentByHash[*corev1.Service, *applycor
 
 func NewEnsureComponentByHash[K KubeObject, A Annotator[A]](
 	component *HashableComponent[K],
-	owner MustValueContext[types.NamespacedName],
-	ctrls *ContextKey[ControlAll],
+	owner typedctx.MustValueContext[types.NamespacedName],
+	ctrls *typedctx.Key[queue.Interface],
 	applyObj func(ctx context.Context, apply A) (K, error),
 	deleteObject func(ctx context.Context, nn types.NamespacedName) error,
 	newObj func(ctx context.Context) A,