Skip to content
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.

Sign up for GitHub

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

Jump to bottom

✨ support disable deepcopy on list funcion #2076

Merged
merged 1 commit into from
Dec 6, 2022
Merged

✨ support disable deepcopy on list funcion #2076

merged 1 commit into from
Dec 6, 2022

Conversation

qiankunli
Copy link
Contributor

@qiankunli qiankunli commented Dec 5, 2022 •
edited
Loading

related issue: #1274

If the all object of a specific GVK supports DisableDeepCopy option, the risk is too great. it may be a better way to specify DisableDeepCopy option every time list function is called

example code

out := corev1.PodList{}
cache.List(context.Background(), &out, client.UnsafeDisableDeepCopy)

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Dec 5, 2022 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Dec 5, 2022
@k8s-ci-robot
Copy link
Contributor

Welcome @qiankunli!

It looks like this is your first PR to kubernetes-sigs/controller-runtime 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/controller-runtime has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

Hi @qiankunli. Thanks for your PR.

I'm waiting for a kubernetes-sigs 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.

@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. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Dec 5, 2022
@qiankunli qiankunli force-pushed the feature/support_disabledeepcopy_on_function branch 4 times, most recently from 36d84ae to 4595915 Compare December 5, 2022 14:21
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Dec 5, 2022
alvaroaleman
alvaroaleman reviewed Dec 6, 2022
View reviewed changes
Copy link
Member

@alvaroaleman alvaroaleman left a comment

Choose a reason for hiding this comment

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

/ok-to-test

pkg/client/options.go Outdated
// disableDeepCopy indicates not to deep copy objects during list objects.
// Be very careful with this, when enabled you must DeepCopy any object before mutating it,
// otherwise you will mutate the object in the cache.
DisableDeepCopy bool
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
DisableDeepCopy bool
UnsafeDisableDeepCopy bool

pkg/cache/internal/cache_reader.go Outdated
@@ -161,7 +161,7 @@ func (c *CacheReader) List(_ context.Context, out client.ObjectList, opts ...cli
}

var outObj runtime.Object
if c.disableDeepCopy {
if c.disableDeepCopy || listOpts.DisableDeepCopy {
Copy link
Member

Choose a reason for hiding this comment

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

Please add a test for this, maybe by checking that the pointer for the obj is the same as for the one in the cache

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Please add a test for this, maybe by checking that the pointer for the obj is the same as for the one in the cache

done

@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 Dec 6, 2022
@qiankunli qiankunli force-pushed the feature/support_disabledeepcopy_on_function branch from 4595915 to 40ec9b7 Compare December 6, 2022 04:33
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Dec 6, 2022
@qiankunli qiankunli changed the title feat: supprot disable deepcopy on list funcion ✨ supprot disable deepcopy on list funcion Dec 6, 2022
@qiankunli qiankunli force-pushed the feature/support_disabledeepcopy_on_function branch 3 times, most recently from d04e5a6 to ffdccf5 Compare December 6, 2022 05:56
@qiankunli qiankunli force-pushed the feature/support_disabledeepcopy_on_function branch from ffdccf5 to 59682cb Compare December 6, 2022 06:29
vincepri
vincepri approved these changes Dec 6, 2022
View reviewed changes
Copy link
Member

@vincepri vincepri left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 6, 2022
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiankunli, vincepri

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

The pull request process is described 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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 6, 2022
@alvaroaleman alvaroaleman changed the title ✨ supprot disable deepcopy on list funcion ✨ support disable deepcopy on list funcion Dec 6, 2022
@k8s-ci-robot k8s-ci-robot merged commit 636fd1f into kubernetes-sigs:master Dec 6, 2022
@qiankunli qiankunli mentioned this pull request Dec 8, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alvaroaleman alvaroaleman alvaroaleman left review comments

@vincepri vincepri vincepri approved these changes

@pwittrock pwittrock Awaiting requested review from pwittrock

Assignees

@vincepri vincepri

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@qiankunli @k8s-ci-robot @vincepri @alvaroaleman