Skip to content

[client-go #1415] Embed proper interface in TransformingStore to ensure DeltaFIFO and RealFIFO are implementing it #133263

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

valerian-roche
Copy link
Contributor

@valerian-roche valerian-roche commented Jul 28, 2025

What type of PR is this?

/kind bug

What this PR does / why we need it:

This PR is a follow-up to #131799 to improve the memory utilization of informers using transformers.

In #131799 I added a new interface to match stores providing transformers in order to reuse them. The PR was extracted from our fork but a change to embed the Store interface in the TransformingStore (instead of ReflectorStore) mistakenly broke the interface matching. The tests did not catch it as they use fakeStore which is an implementation of Store.
This PR updates the embedded interface to the proper one, and add interface enforcement for DeltaFIFO and RealFIFO. It also updates the test to directly use DeltaFIFO (as this is the structure actually used in the informers).
While adding the tests, I could not reproduce the issue as DeltaFIFO does implement Store through test files only. This is in my opinion a very poor behavior, as in this case tests would have passed without errors and failed again at runtime. It was only discovered while running the new tests against the old behavior and noting an unexpected success.

Which issue(s) this PR is related to:

Fixes kubernetes/client-go#1415

Special notes for your reviewer:

The only functional change of the PR is the replacement of the embedded interface in TransformingStore. The rest of the PR is for maintainability and updated tests

Does this PR introduce a user-facing change?

NONE

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:


…re to ensure DeltaFIFO and RealFIFO are implementing it

Signed-off-by: Valerian Roche <valerian.roche@datadoghq.com>
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. kind/bug Categorizes issue or PR as related to a bug. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jul 28, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @valerian-roche. 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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. 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 Jul 28, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: valerian-roche
Once this PR has been reviewed and has the lgtm label, please assign deads2k for approval. For more information see the 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:

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

@aojea
Copy link
Member

aojea commented Jul 29, 2025

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 29, 2025
@liggitt
Copy link
Member

liggitt commented Jul 29, 2025

It also updates the test to directly use DeltaFIFO (as this is the structure actually used in the informers).

I'm pretty sure RealFIFO is the structure actually used in informers by default

@valerian-roche
Copy link
Contributor Author

It also updates the test to directly use DeltaFIFO (as this is the structure actually used in the informers).

I'm pretty sure RealFIFO is the structure actually used in informers by default

Both are still in the code, not sure which one is used by default now. I can set the test to run with both if needed

Signed-off-by: Valerian Roche <valerian.roche@datadoghq.com>
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 31, 2025
@valerian-roche
Copy link
Contributor Author

It also updates the test to directly use DeltaFIFO (as this is the structure actually used in the informers).

I'm pretty sure RealFIFO is the structure actually used in informers by default

Updated the test to run against both

metav1.InitialEventsAnnotationKey: "true",
type testReflectorStore interface {
ReflectorStore
list() []interface{}
Copy link
Member

Choose a reason for hiding this comment

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

can this test introspect the items in the stores without adding methods to the implementations in the _test files?

Copy link
Contributor Author

@valerian-roche valerian-roche Aug 5, 2025

Choose a reason for hiding this comment

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

Yes let me rewrite those - updated.
This complexity the test a bit but this can be cleaned once DeltaFIFO is fully removed

@liggitt
Copy link
Member

liggitt commented Aug 4, 2025

/retest

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Aug 4, 2025
@k8s-ci-robot
Copy link
Contributor

@valerian-roche: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-kubernetes-apidiff-client-go 288d49f link false /test pull-kubernetes-apidiff-client-go
pull-kubernetes-e2e-gce 288d49f link true /test pull-kubernetes-e2e-gce

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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-sigs/prow repository. I understand the commands that are listed here.

@seans3
Copy link
Contributor

seans3 commented Aug 7, 2025

/triage accepted

@k8s-ci-robot 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 Aug 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/bug Categorizes issue or PR as related to a bug. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesn't merit a release note. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Informers: ensure transformers apply per-event when using streaming API
5 participants