Skip to content

Commit

Permalink
Return error when object limit exceeded for cached list calls
Browse files Browse the repository at this point in the history
Since the cache does not implement strongly consistent paginated list
calls, if the Limit option is set and the number of items listed exceeds
this limit, there is no way for the caller to get a complete list of
objects, so return an error here to notify the caller.
  • Loading branch information
chhsia0 committed Dec 20, 2024
1 parent aea2e32 commit 3600637
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions pkg/cache/internal/cache_reader.go
Original file line number Diff line number Diff line change
Expand Up @@ -139,15 +139,17 @@ func (c *CacheReader) List(_ context.Context, out client.ObjectList, opts ...cli
labelSel = listOpts.LabelSelector
}

// Since the cache does not implement strongly consistent paginated list
// calls, if the Limit option is set and the number of items listed exceeds
// this limit, there is no way for the caller to get a complete list of
// objects, so return an error here to notify the caller.
limitSet := listOpts.Limit > 0
if limitSet && int64(len(objs)) > listOpts.Limit {
return fmt.Errorf("object limit exceeded but paginated list is not supported by the cache")
}

runtimeObjs := make([]runtime.Object, 0, len(objs))
for _, item := range objs {
// if the Limit option is set and the number of items
// listed exceeds this limit, then stop reading.
if limitSet && int64(len(runtimeObjs)) >= listOpts.Limit {
break
}
obj, isObj := item.(runtime.Object)
if !isObj {
return fmt.Errorf("cache contained %T, which is not an Object", item)
Expand Down

0 comments on commit 3600637

Please sign in to comment.