Skip to content

Attempt to start list watch from last resourceVersion #711

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
Merged
merged 2 commits into from
Aug 24, 2021
Merged

Attempt to start list watch from last resourceVersion #711

merged 2 commits into from
Aug 24, 2021

Conversation

bbatha
Copy link
Contributor

@bbatha bbatha commented Aug 20, 2021 •
edited
Loading

This change should avoid unnecessary calls to the listFn that populates
the ListWatch cache by first attempting to start the watch from the last
resourceVersion. If a 410 Gone is detected it will fallback to the full
list call.

@k8s-ci-robot
Copy link
Contributor

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

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

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

Welcome @bbatha!

It looks like this is your first PR to kubernetes-client/javascript 🎉. 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-client/javascript 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 k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 20, 2021
@bbatha
Attempt to start list watch from last resourceVersion
e7f758e 
This change should avoid unnecessary calls to the listFn that populates
the ListWatch cache by first attempting to start the watch from the last
resourceVersion. If a 410 Gone is detected it will fallback to the full
list call.
@bbatha bbatha force-pushed the fix-list-watch-410-optimization branch from ec23213 to e7f758e Compare August 20, 2021 16:46
@bbatha
Copy link
Contributor Author

bbatha commented Aug 20, 2021

I signed it

@bbatha
Copy link
Contributor Author

bbatha commented Aug 20, 2021

/check-cla

brendandburns
brendandburns reviewed Aug 22, 2021
View reviewed changes
src/cache.ts Outdated
@@ -120,7 +120,9 @@ export class ListWatch<T extends KubernetesObject> implements ObjectCache<T>, In

private async doneHandler(err: any): Promise<any> {
this._stop();
if (err) {
if (err?.message === 'Gone') {
Copy link
Contributor

Choose a reason for hiding this comment

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

Please check the status code (410) vs the text

brendandburns
brendandburns reviewed Aug 22, 2021
View reviewed changes
src/cache.ts Outdated
}
});
this.addOrUpdateItems(list.items);
queryParams.resourceVersion = list.metadata!.resourceVersion;
Copy link
Contributor

Choose a reason for hiding this comment

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

Shouldn't this be this.resourceVersion?

@bbatha
Copy link
Contributor Author

bbatha commented Aug 22, 2021

Requested changes made.

@bbatha bbatha requested a review from brendandburns August 22, 2021 21:41
bbatha
bbatha commented Aug 22, 2021
View reviewed changes
src/cache_test.ts
@@ -197,7 +197,9 @@ describe('ListWatchCache', () => {
} as V1ObjectMeta,
} as V1Namespace);

await doneHandler(null);
const error = new Error('Gone') as Error & { statusCode: number | undefined };
Copy link
Contributor Author

Choose a reason for hiding this comment

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

These two tests relied on doneHandler calling listFn every time.

@brendandburns
Copy link
Contributor

This looks good to me, but something is still messed up w/ your CLA.

@bbatha
Copy link
Contributor Author

bbatha commented Aug 24, 2021

/check-cla

@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 Aug 24, 2021
@bbatha
Copy link
Contributor Author

bbatha commented Aug 24, 2021

@brendanburns CLA issues sorted out, thanks for the quick reviews!

@brendandburns
Copy link
Contributor

/lgtm
/approve

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: bbatha, brendandburns

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 Aug 24, 2021
@k8s-ci-robot k8s-ci-robot merged commit 7b0c928 into kubernetes-client:master Aug 24, 2021
@dominykas dominykas mentioned this pull request Sep 19, 2022
Closed
@brendandburns brendandburns mentioned this pull request Feb 2, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@drubin drubin Awaiting requested review from drubin

@brendandburns brendandburns Awaiting requested review from brendandburns

Assignees

@brendandburns brendandburns

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. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@bbatha @k8s-ci-robot @brendandburns