Skip to content

⚠ refactor(builder): Consolidate validation logic and simplify duplicated watch-related code #3294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
s-z-z wants to merge 2 commits into from
Closed

⚠ refactor(builder): Consolidate validation logic and simplify duplicated watch-related code #3294

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5b6b801
refactor(builder): Consolidate validation logic and simplify duplicat…
s-z-z Aug 21, 2025
292cb52
refactor(builder): put forInput validation in For()
s-z-z Aug 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 27 additions & 20 deletions pkg/builder/controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,16 @@ type ForInput struct {
func (blder *TypedBuilder[request]) For(object client.Object, opts ...ForOption) *TypedBuilder[request] {
if blder.forInput.object != nil {
blder.forInput.err = fmt.Errorf("For(...) should only be called once, could not assign multiple objects for reconciliation")
}

if reflect.TypeFor[request]() != reflect.TypeOf(reconcile.Request{}) {
blder.forInput.err = fmt.Errorf("For() can only be used with reconcile.Request, got %T", *new(request))
}

if blder.forInput.err != nil {
return blder
}

input := ForInput{object: object}
for _, opt := range opts {
opt.ApplyToFor(&input)
Expand Down Expand Up @@ -273,6 +281,14 @@ func (blder *TypedBuilder[request]) Build(r reconcile.TypedReconciler[request])
if blder.forInput.err != nil {
return nil, blder.forInput.err
}
if blder.forInput.object == nil {
if len(blder.ownsInput) > 0 {
return nil, errors.New("Owns() can only be used together with For()")
}
if len(blder.watchesInput) == 0 && len(blder.rawSources) == 0 {
return nil, errors.New("there are no watches configured, controller will never get triggered. Use For(), Owns(), Watches() or WatchesRawSource() to set them up")
}
}

// Set the ControllerManagedBy
if err := blder.doController(r); err != nil {
Expand Down Expand Up @@ -305,31 +321,25 @@ func (blder *TypedBuilder[request]) project(obj client.Object, proj objectProjec
}

func (blder *TypedBuilder[request]) doWatch() error {

var sources []source.TypedSource[request]

// Reconcile type
if blder.forInput.object != nil {
obj, err := blder.project(blder.forInput.object, blder.forInput.objectProjection)
if err != nil {
return err
}

if reflect.TypeFor[request]() != reflect.TypeOf(reconcile.Request{}) {
return fmt.Errorf("For() can only be used with reconcile.Request, got %T", *new(request))
}

var hdler handler.TypedEventHandler[client.Object, request]
reflect.ValueOf(&hdler).Elem().Set(reflect.ValueOf(&handler.EnqueueRequestForObject{}))
allPredicates := append([]predicate.Predicate(nil), blder.globalPredicates...)
allPredicates = append(allPredicates, blder.forInput.predicates...)
src := source.TypedKind(blder.mgr.GetCache(), obj, hdler, allPredicates...)
if err := blder.ctrl.Watch(src); err != nil {
return err
}
sources = append(sources, src)
}

// Watches the managed types
if len(blder.ownsInput) > 0 && blder.forInput.object == nil {
return errors.New("Owns() can only be used together with For()")
}
for _, own := range blder.ownsInput {
obj, err := blder.project(own.object, own.objectProjection)
if err != nil {
Expand All @@ -349,27 +359,24 @@ func (blder *TypedBuilder[request]) doWatch() error {
allPredicates := append([]predicate.Predicate(nil), blder.globalPredicates...)
allPredicates = append(allPredicates, own.predicates...)
src := source.TypedKind(blder.mgr.GetCache(), obj, hdler, allPredicates...)
if err := blder.ctrl.Watch(src); err != nil {
return err
}
sources = append(sources, src)
}

// Do the watch requests
if len(blder.watchesInput) == 0 && blder.forInput.object == nil && len(blder.rawSources) == 0 {
return errors.New("there are no watches configured, controller will never get triggered. Use For(), Owns(), Watches() or WatchesRawSource() to set them up")
}
for _, w := range blder.watchesInput {
projected, err := blder.project(w.obj, w.objectProjection)
if err != nil {
return fmt.Errorf("failed to project for %T: %w", w.obj, err)
}
allPredicates := append([]predicate.Predicate(nil), blder.globalPredicates...)
allPredicates = append(allPredicates, w.predicates...)
if err := blder.ctrl.Watch(source.TypedKind(blder.mgr.GetCache(), projected, w.handler, allPredicates...)); err != nil {
return err
}
src := source.TypedKind(blder.mgr.GetCache(), projected, w.handler, allPredicates...)
sources = append(sources, src)
}
for _, src := range blder.rawSources {

sources = append(sources, blder.rawSources...)

for _, src := range sources {
if err := blder.ctrl.Watch(src); err != nil {
return err
}
Expand Down