Skip to content

🐛 Cache reader: Wait for cache sync when ReaderFailOnMissingInformer is true #3425

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

Merged
k8s-ci-robot merged 1 commit into from
Jan 25, 2026
+25 −21
Merged

🐛 Cache reader: Wait for cache sync when ReaderFailOnMissingInformer is true #3425

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 7 additions & 20 deletions pkg/cache/informer_cache.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,16 +51,7 @@ var _ error = (*ErrCacheNotStarted)(nil)
// ErrResourceNotCached indicates that the resource type
// the client asked the cache for is not cached, i.e. the
// corresponding informer does not exist yet.
type ErrResourceNotCached struct {
GVK schema.GroupVersionKind
}

// Error returns the error
func (r ErrResourceNotCached) Error() string {
return fmt.Sprintf("%s is not cached", r.GVK.String())
}

var _ error = (*ErrResourceNotCached)(nil)
type ErrResourceNotCached = internal.ErrResourceNotCached

// informerCache is a Kubernetes Object cache populated from internal.Informers.
// informerCache wraps internal.Informers.
Expand Down Expand Up @@ -157,7 +148,7 @@ func (ic *informerCache) GetInformerForKind(ctx context.Context, gvk schema.Grou
return nil, err
}

_, i, err := ic.Informers.Get(ctx, gvk, obj, applyGetOptions(opts...))
_, i, err := ic.Informers.Get(ctx, gvk, obj, false, applyGetOptions(opts...))
if err != nil {
return nil, err
}
Expand All @@ -171,23 +162,19 @@ func (ic *informerCache) GetInformer(ctx context.Context, obj client.Object, opt
return nil, err
}

_, i, err := ic.Informers.Get(ctx, gvk, obj, applyGetOptions(opts...))
_, i, err := ic.Informers.Get(ctx, gvk, obj, false, applyGetOptions(opts...))
if err != nil {
return nil, err
}
return i.Informer, nil
}

func (ic *informerCache) getInformerForKind(ctx context.Context, gvk schema.GroupVersionKind, obj runtime.Object) (bool, *internal.Cache, error) {
Copy link
Member

@alvaroaleman alvaroaleman Jan 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Its not very obvious from the code but this is the only place where we need to pass ic.readerFailOnMissingInformer, in the two others we need to pass false.
This is because this here is only used by the cache reader whereas GetInformer and GetInformerForKind are methods on the cache. If those error out when readerFailOnMissingInformer is true, it becomes impossible to construct an informer at all

if ic.readerFailOnMissingInformer {
cache, started, ok := ic.Informers.Peek(gvk, obj)
if !ok {
return false, nil, &ErrResourceNotCached{GVK: gvk}
}
return started, cache, nil
started, cache, err := ic.Informers.Get(ctx, gvk, obj, ic.readerFailOnMissingInformer, &internal.GetOptions{})
if err != nil {
return false, nil, err
}

return ic.Informers.Get(ctx, gvk, obj, &internal.GetOptions{})
return started, cache, nil
}

// RemoveInformer deactivates and removes the informer from the cache.
Expand Down
19 changes: 18 additions & 1 deletion pkg/cache/internal/informers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,20 @@ import (

var log = logf.RuntimeLog.WithName("cache")

// ErrResourceNotCached indicates that the resource type
// the client asked the cache for is not cached, i.e. the
// corresponding informer does not exist yet.
type ErrResourceNotCached struct {
GVK schema.GroupVersionKind
}

// Error returns the error
func (r ErrResourceNotCached) Error() string {
return fmt.Sprintf("%s is not cached", r.GVK.String())
}

var _ error = (*ErrResourceNotCached)(nil)

// InformersOpts configures an InformerMap.
type InformersOpts struct {
HTTPClient *http.Client
Expand Down Expand Up @@ -294,10 +308,13 @@ func (ip *Informers) Peek(gvk schema.GroupVersionKind, obj runtime.Object) (res

// Get will create a new Informer and add it to the map of specificInformersMap if none exists. Returns
// the Informer from the map.
func (ip *Informers) Get(ctx context.Context, gvk schema.GroupVersionKind, obj runtime.Object, opts *GetOptions) (bool, *Cache, error) {
func (ip *Informers) Get(ctx context.Context, gvk schema.GroupVersionKind, obj runtime.Object, readerFailOnMissingInformer bool, opts *GetOptions) (bool, *Cache, error) {
// Return the informer if it is found
i, started, ok := ip.Peek(gvk, obj)
if !ok {
if readerFailOnMissingInformer {
return false, nil, &ErrResourceNotCached{GVK: gvk}
}
var err error
if i, started, err = ip.addInformerToMap(gvk, obj); err != nil {
return started, nil, err
Expand Down
Loading