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

Update storage.GuaranteedUpdate to be clearer #109514

Merged
merged 1 commit into from May 4, 2022
Merged

Update storage.GuaranteedUpdate to be clearer #109514

merged 1 commit into from May 4, 2022

Conversation

aryan9600
Copy link
Member

@aryan9600 aryan9600 commented Apr 16, 2022 •
edited

Signed-off-by: Sanskar Jaiswal jaiswalsanskar078@gmail.com

What type of PR is this?

/kind cleanup

What this PR does / why we need it:

Makes the description of storage.Interface.GuaranteedUpdate clearer and accurate. Renames ptrToType to out ptrToType to destination, to better convey the functionality of the argument.

Which issue(s) this PR fixes:

Fixes #107534

Does this PR introduce a user-facing change?

NONE

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. 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 Apr 16, 2022
@k8s-ci-robot
Copy link
Contributor

Hi @aryan9600. 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.

@k8s-ci-robot k8s-ci-robot added needs-priority Indicates a PR lacks a `priority/foo` label and requires one. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Apr 16, 2022
@k8s-ci-robot k8s-ci-robot added area/apiserver 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 Apr 16, 2022
@MadhavJivrajani
Copy link
Contributor

/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 Apr 18, 2022
@fedebongio
Copy link
Contributor

/assign @MikeSpreitzer @lavalamp
/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 Apr 19, 2022
lavalamp
lavalamp reviewed Apr 19, 2022
View reviewed changes
staging/src/k8s.io/apiserver/pkg/registry/generic/registry/dryrun.go Outdated
@@ -69,28 +69,28 @@ func (s *DryRunnableStorage) GetList(ctx context.Context, key string, opts stora
}

func (s *DryRunnableStorage) GuaranteedUpdate(
ctx context.Context, key string, ptrToType runtime.Object, ignoreNotFound bool,
ctx context.Context, key string, out runtime.Object, ignoreNotFound bool,
Copy link
Member

Choose a reason for hiding this comment

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

This is like, memory to store the object in that has the right type. I don't think "out" is a good name for that.

Copy link
Member Author

Choose a reason for hiding this comment

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

I thought out would be fine as that's where the actual output of operations executed in Get() and GuaranteedUpdate() gets stored. What would you rather we change it to?

Copy link
Member

Choose a reason for hiding this comment

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

It's a hard question!

The reason this is an input parameter is because this function needs to know the type to use, there's no way for it to construct a variable of the right type. That we also use this to store the result is accidental -- if that were the primary purpose here, we'd return that as an output parameter.

The best I can come up with at the moment is resultDestination or maybe just destination but I'm not in love with that, either.

Copy link
Member

Choose a reason for hiding this comment

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

"memory to store the object" sounds a lot like output!
And yes, this is also being used to input the type.
I think both resultDestination and destination are fine and sufficient improvements to ptrToType.

@aryan9600
Update comment and declaration of storage.GuaranteedUpdate to be cl…
f8df26a 
…earer.

Signed-off-by: Sanskar Jaiswal <jaiswalsanskar078@gmail.com>
@aryan9600
Copy link
Member Author

/retest-required

MikeSpreitzer
MikeSpreitzer approved these changes Apr 24, 2022
View reviewed changes
Copy link
Member

@MikeSpreitzer MikeSpreitzer 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 Apr 24, 2022
@lavalamp
Copy link
Member

/lgtm
/approve
/milestone v1.25

@k8s-ci-robot k8s-ci-robot added this to the v1.25 milestone Apr 25, 2022
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aryan9600, lavalamp, MikeSpreitzer

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 Apr 25, 2022
@k8s-ci-robot k8s-ci-robot merged commit 7e8a35e into kubernetes:master May 4, 2022
@aryan9600 aryan9600 mentioned this pull request Sep 7, 2022
Closed
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lavalamp lavalamp lavalamp left review comments

@MikeSpreitzer MikeSpreitzer MikeSpreitzer approved these changes

@deads2k deads2k Awaiting requested review from deads2k

@enj enj Awaiting requested review from enj

Assignees

@lavalamp lavalamp

@MikeSpreitzer MikeSpreitzer

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/apiserver cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. lgtm "Looks good to me", indicates that a PR is ready to be merged. 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/M Denotes a PR that changes 30-99 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
v1.25
Development

Successfully merging this pull request may close these issues.

Outdated/confusing stuff in apiserver storage
6 participants
@aryan9600 @k8s-ci-robot @MadhavJivrajani @fedebongio @lavalamp @MikeSpreitzer