apimachinery: fix UnsafeGuessKindToResource for some classes of words #110053

michaelbeaumont · 2022-05-14T16:34:10Z

What type of PR is this?

/kind bug

What this PR does / why we need it:

Fixes guesses that apimachinery makes about resource names from a GVK.

Which issue(s) this PR fixes:

Fixes kubernetes/client-go#1082

Special notes for your reviewer:

Does this PR introduce a user-facing change?

NONE

k8s-ci-robot · 2022-05-14T16:34:18Z

Hi @michaelbeaumont. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

roycaihw · 2022-05-17T20:16:22Z

/assign @apelisse
/triage accepted

apelisse · 2022-05-18T22:49:53Z

/ok-to-test
/lgtm

Not sure if this breaks compatibility with anything.

AlexanderYastrebov · 2022-05-19T22:11:42Z

The https://github.com/kubernetes/code-generator uses https://pkg.go.dev/k8s.io/gengo/namer#NewAllLowercasePluralNamer so another option might be to use it here or make client-go use it instead of UnsafeGuessKindToResource that is documented as broken.

evankanderson · 2022-06-28T09:07:11Z

FWIW, this affects https://gateway-api.sigs.k8s.io/, which is sort of annoying (spent about 2-3 hours debugging why a test framework using .Add wasn't finding my Gateway).

👍 on this change from me.

ncdc · 2022-07-13T19:58:01Z

/uncc

evankanderson · 2022-07-14T00:46:33Z

/assign @deads2k

pmalek · 2022-08-09T12:59:18Z

Also hit this when using Gateway API's objects with dynamic fake client: k8s.io/client-go/dynamic/fake's NewSimpleDynamicClientWithCustomListKinds (just as @evankanderson described it).

Any (even rough) ETA for this? Any workarounds before this gets merged?

k8s-triage-robot · 2022-11-07T13:09:30Z

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle stale
Mark this issue or PR as rotten with /lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

evankanderson · 2022-11-07T14:28:24Z

/remove-lifecycle stale

pmalek · 2022-11-20T17:34:05Z

Any chance that we can get someone else to look at this and review it (as @deads2k and @apelisse seem not be able to pick this up)?

apelisse · 2022-11-21T22:06:22Z

Why would you throw me under the bus? I've lgtm'd 6 months ago! 😄

pmalek · 2022-11-22T09:56:42Z

@apelisse sorry 😅 Didn't notice that (and the fact that still @deads2k is assigned as reviewer: so I guess we need lgtm from him). My bad.

k8s-ci-robot · 2022-12-12T10:34:07Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: michaelbeaumont, pmalek
Once this PR has been reviewed and has the lgtm label, please ask for approval from deads2k by writing /assign @deads2k in a comment. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

staging/src/k8s.io/apimachinery/pkg/OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

evankanderson · 2022-12-12T18:20:25Z

/assign caesarxuchao

lavalamp · 2022-12-12T18:25:18Z

I think we might have this code locked because changing it could break existing things and pluralizing english is hopeless unless we can call out to GPT-3 anyway.

There should be fields to define both in CRDs to avoid this code being invoked, if that's not the case please let us know.

liggitt · 2022-12-12T18:28:12Z

staging/src/k8s.io/apimachinery/pkg/api/meta/restmapper.go

@@ -137,10 +137,19 @@ func UnsafeGuessKindToResource(kind schema.GroupVersionKind) ( /*plural*/ schema
 		}
 	}

-	switch string(singularName[len(singularName)-1]) {
-	case "s":
+	switch {


/hold

This isn't a compatible change to make to this function. Anything using this function to auto-generate plural names from singular names would break when re-generating an existing object that this change impacts.

I think we should remove all non-test in-tree calls to this function (I only see a single call from DefaultRESTMapper#Add, which I would also consider removing), mark it deprecated, file issues to public callers we find, and consider removing it in a future release.

If we want a new function that takes a singular name and pluralizes it that has this expanded behavior from the start (with a signature like AttemptToPluralize(singular string) (plural string)), I guess I wouldn't object, but that doesn't need to live in k8s.io/apimachinery

I believe that the use that bit me was in test code without an apiserver loaded. I can try to dig out the code in question; I believe it tries to pluralize "Gateway" as "Gatewaies", which was very confusing when I finally debugged it.

Removing this function would also be acceptable to me, but it's currently a trap for anyone testing the Gateway API.

@evankanderson Can you dig that test code up? I'm positive I've also encountered this issue recently but can't find the relevant test code that would manifest the problem itself (other than calling UnsafeGuessKindToResource with Gateway type).

https://grep.app/search?q=.UnsafeGuessKindToResource%28&case=true doesn't show that many public callers 👍

I believe that we were getting hung up in tracker.Add from this code:

https://github.com/kubernetes/client-go/blob/master/testing/fixture.go#L341

I also see some questionable usage in https://github.com/knative/pkg/blob/main/resolver/addressable_resolver.go#L167 and https://github.com/knative/pkg/blob/main/kref/knative_reference.go#L53, but the usage of ObjectTracker from client-go/testing seems most likely to cause problems, because I'm guessing that package is used many places.

You can see my work-around here:

https://github.com/knative-sandbox/net-gateway-api/blob/main/pkg/reconciler/ingress/ingress_test.go#L404

// The fake tracker's `Add` method incorrectly pluralizes "gatewaies" using UnsafeGuessKindToResource, // so create this via explicit call (per note in client-go/testing/fixture.go in tracker.Add) fakeCreates := []runtime.Object{} for _, x := range tr.Objects { myGw, ok := x.(*gatewayapi.Gateway) if ok { fakegwapiclientset.Get(ctx).GatewayV1beta1().Gateways(myGw.Namespace).Create(ctx, myGw, metav1.CreateOptions{}) tr.SkipNamespaceValidation = true fakeCreates = append(fakeCreates, myGw) } } tr.WantCreates = append(fakeCreates, tr.WantCreates...)

liggitt · 2023-03-30T15:37:41Z

/close

Changing this function is not the right direction. I would be in favor of marking as deprecated and removing all in-tree calls to it, and adding the ability for fake clients to be told the accurate plural/singular mappings if needed.

k8s-ci-robot · 2023-03-30T15:37:48Z

@liggitt: Closed this PR.

In response to this:

/close

Changing this function is not the right direction. I would be in favor of marking as deprecated and removing all in-tree calls to it, and adding the ability for fake clients to be told the accurate plural/singular mappings if needed.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

pmalek · 2023-06-10T11:48:32Z

@liggitt I'd like to move forward with this somehow but I'm having hard time understanding your proposal.

E.g. how would you go about removing in-tree calls of this? There are multiple places where it's used in user facing code e.g.

kubernetes/staging/src/k8s.io/apimachinery/pkg/api/meta/restmapper.go

Lines 99 to 113 in 694698c

    
           func (m *DefaultRESTMapper) Add(kind schema.GroupVersionKind, scope RESTScope) { 
        
           	plural, singular := UnsafeGuessKindToResource(kind) 
        
           	m.AddSpecific(kind, plural, singular, scope) 
        
           } 
        
           func (m *DefaultRESTMapper) AddSpecific(kind schema.GroupVersionKind, plural, singular schema.GroupVersionResource, scope RESTScope) { 
        
           	m.singularToPlural[singular] = plural 
        
           	m.pluralToSingular[plural] = singular 
        
           	m.resourceToKind[singular] = kind 
        
           	m.resourceToKind[plural] = kind 
        
           	m.kindToPluralResource[kind] = plural 
        
           	m.kindToScope[kind] = scope 
        
           }

Would you suggest to mark func (m *DefaultRESTMapper) Add(kind schema.GroupVersionKind, scope RESTScope) as deprecated as well due to its usage of UnsafeGuessKindToResource and suggest users to use AddSpecific() instead?

pmalek · 2023-06-10T12:18:00Z

It seems that using k8s.io/gengo/namer's NewAllLowercasePluralNamer() would work:

func (m *DefaultRESTMapper) Add(kind schema.GroupVersionKind, scope RESTScope) {
	n := namer.NewAllLowercasePluralNamer(nil)
	t := types.Ref(kind.GroupVersion().String(), kind.Kind)
	plural := kind.GroupVersion().WithResource(n.Name(t))
	singular := kind.GroupVersion().WithResource(strings.ToLower(kind.Kind))

	m.AddSpecific(kind, plural, singular, scope)
}

If this would be accepted and is perceived as the direction that we can move forward with, I can submit a PR replacing usages of UnsafeGuessKindToResource with the above.

liggitt · 2023-07-05T17:18:54Z

Would you suggest to mark func (m *DefaultRESTMapper) Add(kind schema.GroupVersionKind, scope RESTScope) as deprecated as well due to its usage of UnsafeGuessKindToResource and suggest users to use AddSpecific() instead?

yes, mark deprecated and mark callers that rely on it as deprecated as well, pointing people to AddSpecific

pmalek · 2023-08-13T11:37:14Z

@liggitt I've pushed #119924 to try to address the above PTAL.

apimachinery: fix UnsafeGuessKindToResource for some classes of words

0383802

k8s-ci-robot added needs-priority Indicates a PR lacks a `priority/foo` label and requires one. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels May 14, 2022

k8s-ci-robot requested review from deads2k and ncdc May 14, 2022 16:35

k8s-ci-robot assigned apelisse May 17, 2022

k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels May 17, 2022

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. lgtm "Looks good to me", indicates that a PR is ready to be merged. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 18, 2022

k8s-ci-robot removed the request for review from ncdc July 13, 2022 19:58

k8s-ci-robot assigned deads2k Jul 14, 2022

This was referenced Aug 9, 2022

Pluralization discrepancy in UnsafeGuessKindToResource still exists kubernetes/client-go#1082

Open

feat: add hostname, uptime and gateway count providers Kong/kubernetes-telemetry#40

Merged

pmalek mentioned this pull request Aug 9, 2022

Counting gateways doesn't work in tests due to upstream bug Kong/kubernetes-telemetry#43

Open

This was referenced Aug 19, 2022

Some resources cannot use success/failure conditions at all due to bug in UnsafeGuessKindToResource argoproj/argo-workflows#9393

Closed

fix(executor): Resource template gets incorrect plural for certain types argoproj/argo-workflows#9396

Merged

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Nov 7, 2022

k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Nov 7, 2022

pmalek approved these changes Dec 12, 2022

View reviewed changes

k8s-ci-robot assigned caesarxuchao Dec 12, 2022

liggitt reviewed Dec 12, 2022

View reviewed changes

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 12, 2022

pmalek mentioned this pull request Feb 15, 2023

refactor: use kubernetes-telemetry package Kong/kubernetes-ingress-controller#3552

Merged

1 task

k8s-ci-robot closed this Mar 30, 2023

pmalek mentioned this pull request Aug 13, 2023

chore(apimachinery): deprecate meta.UnsafeGuessKindToResource #119924

Closed

liggitt mentioned this pull request Mar 14, 2024

api: add plural exception for "parameters" #123936

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

apimachinery: fix UnsafeGuessKindToResource for some classes of words #110053

apimachinery: fix UnsafeGuessKindToResource for some classes of words #110053

michaelbeaumont commented May 14, 2022

k8s-ci-robot commented May 14, 2022

roycaihw commented May 17, 2022

apelisse commented May 18, 2022

AlexanderYastrebov commented May 19, 2022

evankanderson commented Jun 28, 2022

ncdc commented Jul 13, 2022

evankanderson commented Jul 14, 2022

pmalek commented Aug 9, 2022 •

edited

Loading

k8s-triage-robot commented Nov 7, 2022

evankanderson commented Nov 7, 2022

pmalek commented Nov 20, 2022

apelisse commented Nov 21, 2022

pmalek commented Nov 22, 2022

k8s-ci-robot commented Dec 12, 2022

evankanderson commented Dec 12, 2022

lavalamp commented Dec 12, 2022

liggitt Dec 12, 2022 •

edited

Loading

evankanderson Dec 13, 2022 •

edited

Loading

pmalek Feb 12, 2023 •

edited

Loading

evankanderson Feb 12, 2023 •

edited

Loading

liggitt commented Mar 30, 2023

k8s-ci-robot commented Mar 30, 2023

pmalek commented Jun 10, 2023

pmalek commented Jun 10, 2023

liggitt commented Jul 5, 2023 •

edited

Loading

pmalek commented Aug 13, 2023

apimachinery: fix UnsafeGuessKindToResource for some classes of words #110053

apimachinery: fix UnsafeGuessKindToResource for some classes of words #110053

Conversation

michaelbeaumont commented May 14, 2022

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?

k8s-ci-robot commented May 14, 2022

roycaihw commented May 17, 2022

apelisse commented May 18, 2022

AlexanderYastrebov commented May 19, 2022

evankanderson commented Jun 28, 2022

ncdc commented Jul 13, 2022

evankanderson commented Jul 14, 2022

pmalek commented Aug 9, 2022 • edited Loading

k8s-triage-robot commented Nov 7, 2022

evankanderson commented Nov 7, 2022

pmalek commented Nov 20, 2022

apelisse commented Nov 21, 2022

pmalek commented Nov 22, 2022

k8s-ci-robot commented Dec 12, 2022

evankanderson commented Dec 12, 2022

lavalamp commented Dec 12, 2022

liggitt Dec 12, 2022 • edited Loading

Choose a reason for hiding this comment

evankanderson Dec 13, 2022 • edited Loading

Choose a reason for hiding this comment

pmalek Feb 12, 2023 • edited Loading

Choose a reason for hiding this comment

evankanderson Feb 12, 2023 • edited Loading

Choose a reason for hiding this comment

liggitt commented Mar 30, 2023

k8s-ci-robot commented Mar 30, 2023

pmalek commented Jun 10, 2023

pmalek commented Jun 10, 2023

liggitt commented Jul 5, 2023 • edited Loading

pmalek commented Aug 13, 2023

pmalek commented Aug 9, 2022 •

edited

Loading

liggitt Dec 12, 2022 •

edited

Loading

evankanderson Dec 13, 2022 •

edited

Loading

pmalek Feb 12, 2023 •

edited

Loading

evankanderson Feb 12, 2023 •

edited

Loading

liggitt commented Jul 5, 2023 •

edited

Loading