Skip to content

🐛 Return error if pagination is used with the cached client #3134

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.

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
merged 1 commit into from
Feb 26, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
50 changes: 50 additions & 0 deletions pkg/cache/cache_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -861,6 +861,19 @@ func CacheTest(createCacheFunc func(config *rest.Config, opts cache.Options) (ca
Expect(listObj.Items).Should(HaveLen(1))
})

It("should return an error if pagination is used", func() {
listObj := &corev1.PodList{}
By("verifying that the first list works and returns a sentinel continue")
err := informerCache.List(context.Background(), listObj)
Expect(err).ToNot(HaveOccurred())
Expect(listObj.Continue).To(Equal("continue-not-supported"))

By("verifying that an error is returned")
err = informerCache.List(context.Background(), listObj, client.Continue(listObj.Continue))
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(Equal("continue list option is not supported by the cache"))
})

It("should return an error if the continue list options is set", func() {
listObj := &corev1.PodList{}
continueOpt := client.Continue("token")
Expand Down Expand Up @@ -1182,6 +1195,25 @@ func CacheTest(createCacheFunc func(config *rest.Config, opts cache.Options) (ca
Expect(nodeList.Items).NotTo(BeEmpty())
Expect(len(nodeList.Items)).To(BeEquivalentTo(2))
})

It("should return an error if pagination is used", func() {
nodeList := &unstructured.UnstructuredList{}
nodeList.SetGroupVersionKind(schema.GroupVersionKind{
Group: "",
Version: "v1",
Kind: "NodeList",
})
By("verifying that the first list works and returns a sentinel continue")
err := informerCache.List(context.Background(), nodeList)
Expect(err).ToNot(HaveOccurred())
Expect(nodeList.GetContinue()).To(Equal("continue-not-supported"))

By("verifying that an error is returned")
err = informerCache.List(context.Background(), nodeList, client.Continue(nodeList.GetContinue()))
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(Equal("continue list option is not supported by the cache"))
})

It("should return an error if the continue list options is set", func() {
podList := &unstructured.Unstructured{}
continueOpt := client.Continue("token")
Expand Down Expand Up @@ -1511,6 +1543,24 @@ func CacheTest(createCacheFunc func(config *rest.Config, opts cache.Options) (ca
err := informerCache.Get(context.Background(), svcKey, svc)
Expect(err).To(HaveOccurred())
})

It("should return an error if pagination is used", func() {
nodeList := &metav1.PartialObjectMetadataList{}
nodeList.SetGroupVersionKind(schema.GroupVersionKind{
Group: "",
Version: "v1",
Kind: "NodeList",
})
By("verifying that the first list works and returns a sentinel continue")
err := informerCache.List(context.Background(), nodeList)
Expect(err).ToNot(HaveOccurred())
Expect(nodeList.GetContinue()).To(Equal("continue-not-supported"))

By("verifying that an error is returned")
err = informerCache.List(context.Background(), nodeList, client.Continue(nodeList.GetContinue()))
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(Equal("continue list option is not supported by the cache"))
})
})
type selectorsTestCase struct {
options cache.Options
Expand Down
8 changes: 7 additions & 1 deletion pkg/cache/internal/cache_reader.go
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,13 @@ func (c *CacheReader) List(_ context.Context, out client.ObjectList, opts ...cli
}
runtimeObjs = append(runtimeObjs, outObj)
}
return apimeta.SetList(out, runtimeObjs)

if err := apimeta.SetList(out, runtimeObjs); err != nil {
return err
}

out.SetContinue("continue-not-supported")
return nil
}

func byIndexes(indexer cache.Indexer, requires fields.Requirements, namespace string) ([]interface{}, error) {
Expand Down
11 changes: 10 additions & 1 deletion pkg/cache/multi_namespace_cache.go
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,10 @@ func (c *multiNamespaceCache) List(ctx context.Context, list client.ObjectList,
listOpts := client.ListOptions{}
listOpts.ApplyOptions(opts)

if listOpts.Continue != "" {
return fmt.Errorf("continue list option is not supported by the cache")
}

isNamespaced, err := apiutil.IsObjectNamespaced(list, c.Scheme, c.RESTMapper)
if err != nil {
return err
Expand Down Expand Up @@ -316,7 +320,12 @@ func (c *multiNamespaceCache) List(ctx context.Context, list client.ObjectList,
}
listAccessor.SetResourceVersion(resourceVersion)

return apimeta.SetList(list, allItems)
if err := apimeta.SetList(list, allItems); err != nil {
return err
}

list.SetContinue("continue-not-supported")
return nil
}

// multiNamespaceInformer knows how to handle interacting with the underlying informer across multiple namespaces.
Expand Down
Loading