pkg/kube: require namespace in Ctl.List
#1121
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chrisseto
requested review from
RafalKorepta,
andrewstucki and
gene-redpanda
as code owners
`client.Client` and `kube.Ctl` treated `namespace` (`client.InNamespace`) as an optional parameter. If not provided, it default to `"default"`. This parameter has been missed multiple times across various places in our codebase and resulted in latent errors, often because tests utilised the default namespace. This commit changes the signature of `Ctl.List` to require a `namespace string` parameter to make it impossible to forget. It additionally adds it to a few places (lifecycle client) that it was previously forgotten.
chrisseto
force-pushed
the
chris/p/kube-list-ns
branch
from
57eb348 to
c0897a4
Compare
andrewstucki
approved these changes
Oct 1, 2025
| // var pods corev1.PodList | ||
| // ctl.List(ctx, &pods) | ||
| func (c *Ctl) List(ctx context.Context, objs ObjectList, opts ...client.ListOption) error { | ||
| func (c *Ctl) List(ctx context.Context, namespace string, objs ObjectList, opts ...client.ListOption) error { |
Contributor
There was a problem hiding this comment.
I'm fine with this, but wondering, does it make more sense to reverse the order of objs and namespace to be a bit more consistent with the top-level package List?
Contributor
Author
There was a problem hiding this comment.
IMO this is consistent? It follows:
// struct methods
(c *Ctl) Blah(context.Context, RequireArgs, Object/Generic, Options...)
// generics
Blah[T](context.Context, *Ctl, RequireArgs, Options...)
// Get
(c *Ctl) Get(context.Context, ObjectKey, Object)
Get[T](context.Context, ObjectKey)
// List
(c *Ctl) List(context.Context, Namespace, ObjectList, Options...)
List[T](context.Context, Namespace, Options...)The inclusion of Options isn't super consistent and the All methods are a bit weird to support a variadic list of objects 😅
Contributor
Author
There was a problem hiding this comment.
Hm, maybe the generic methods should have had ctl first in hindsight.
Get[T](*Ctl, context.Context, ObjectKey)
This was referenced Oct 1, 2025
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation and see the Github Action logs for details |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
client.Clientandkube.Ctltreatednamespace(client.InNamespace) as an optional parameter. If not provided, it default to"default".This parameter has been missed multiple times across various places in our codebase and resulted in latent errors, often because tests utilised the default namespace.
This commit changes the signature of
Ctl.Listto require anamespace stringparameter to make it impossible to forget. It additionally adds it to a few places (lifecycle client) that it was previously forgotten.