fix: treat rate limiter deadline as context deadline by levenleven · Pull Request #635 · kubernetes-sigs/cli-utils

levenleven · 2023-12-24T15:44:05Z

We often bump into race condition where resource status won't be read because context is reaching the deadline. This results in Unknown status being returned.

This PRs treats this edge case the same way as context.Canceled and context.DeadlineExceeded are treated.

k8s-ci-robot · 2023-12-24T15:44:14Z

Welcome @levenleven!

It looks like this is your first PR to kubernetes-sigs/cli-utils 🎉. 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/cli-utils 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 · 2023-12-24T15:44:15Z

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

Details

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-triage-robot · 2024-03-27T11:31:17Z

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

This bot triages 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 PR is closed

You can:

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

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

/lifecycle stale

karlkfi · 2024-05-08T22:44:58Z

FWIW, we mostly avoid this problem by disabling client-side throttling and depending on server-side throttling to handle slowing down requests. If you do the same, you shouldn't ever see any rate: Wait(n=%d) would exceed context deadline errors.

Unfortunately, that error doesn't have a type, which makes it fragile to catch. And unwrapping only once is also fragile. You would need to either fully unwrap recursively or check for a partial match in the full error message to catch all the edge cases.

That said, what is the behavior you're looking for? Won't it still be status unknown if the context is cancelled?

karlkfi · 2024-05-08T22:45:08Z

/ok-to-test

levenleven · 2024-05-09T05:19:50Z

@karlkfi Thanks for looking into this!

That said, what is the behavior you're looking for? Won't it still be status unknown if the context is cancelled?

No, the poller would keep the previous known status. With current behavior the error is swallowed and the status is overridden with Unknown.

You would need to either fully unwrap recursively or check for a partial match in the full error message to catch all the edge cases.

If this has a chance to be accepted I can do that 🙂

k8s-triage-robot · 2024-08-07T06:04:45Z

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

This bot triages 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 PR is closed

You can:

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

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

/lifecycle stale

k8s-triage-robot · 2024-11-05T07:40:58Z

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

This bot triages 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 PR is closed

You can:

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

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

/lifecycle stale

k8s-triage-robot · 2025-02-03T09:50:05Z

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

This bot triages 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 PR is closed

You can:

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

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

/lifecycle stale

levenleven · 2025-02-05T06:36:13Z

/remove-lifecycle stale

karlkfi · 2025-02-06T01:27:08Z

 	}, nil
 }
+
+func errWouldExceedContextDeadline(err error) bool {


rename: isRateLimiterContextDeadlineExceeded

add a method comment explaining why we need this and what it does

link to the problem in the commit: https://cs.opensource.google/go/x/time/+/refs/tags/v0.10.0:rate/rate.go;l=276

@karlkfi 31ee857 looks ok?

k8s-triage-robot · 2025-05-07T02:36:18Z

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

This bot triages 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 PR is closed

You can:

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

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

/lifecycle stale

There's no dedicated error type for rate limiter "would exceed context deadline" error, hence we check the error message https://cs.opensource.google/go/x/time/+/refs/tags/v0.10.0:rate/rate.go;l=276

karlkfi

Looks good. Thanks!

k8s-ci-robot · 2025-08-31T21:39:56Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: karlkfi, levenleven

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

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [karlkfi]

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

levenleven · 2025-09-07T07:45:47Z

@karlkfi sorry for another ping, looks like lgtm label is required?

karlkfi · 2025-09-07T21:45:43Z

/lgtm

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Dec 24, 2023

k8s-ci-robot requested review from ash2k and mortent December 24, 2023 15:44

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Dec 24, 2023

k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Dec 24, 2023

ash2k reviewed Dec 24, 2023

View reviewed changes

Comment thread pkg/kstatus/polling/statusreaders/common.go Outdated

levenleven force-pushed the rate-deadline branch from a8d5ec1 to 6ebac4a Compare December 25, 2023 07:59

levenleven requested a review from ash2k December 25, 2023 08:01

k8s-ci-robot added lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Mar 27, 2024

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 May 8, 2024

k8s-ci-robot added lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Aug 7, 2024

k8s-ci-robot added lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Nov 5, 2024

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

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

levenleven force-pushed the rate-deadline branch 2 times, most recently from ae7535a to 0ad87ef Compare February 5, 2025 12:32

levenleven commented Feb 5, 2025

View reviewed changes

Comment thread pkg/kstatus/polling/statusreaders/common.go Outdated

levenleven force-pushed the rate-deadline branch 2 times, most recently from 6054a15 to 581f1d5 Compare February 5, 2025 13:02

karlkfi reviewed Feb 6, 2025

View reviewed changes

k8s-ci-robot added lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels May 7, 2025

fix: treat rate limiter deadline as a context deadline

31ee857

There's no dedicated error type for rate limiter "would exceed context deadline" error, hence we check the error message https://cs.opensource.google/go/x/time/+/refs/tags/v0.10.0:rate/rate.go;l=276

levenleven force-pushed the rate-deadline branch from 581f1d5 to 31ee857 Compare July 26, 2025 07:45

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jul 26, 2025

levenleven requested a review from karlkfi July 26, 2025 07:46

karlkfi approved these changes Aug 31, 2025

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 31, 2025

k8s-ci-robot assigned karlkfi Sep 7, 2025

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 7, 2025

k8s-ci-robot merged commit e2d23e7 into kubernetes-sigs:master Sep 7, 2025
5 checks passed

levenleven deleted the rate-deadline branch September 8, 2025 08:49

matheuscscp mentioned this pull request Jan 9, 2026

fix: treat rate limiter deadline as a context deadline fluxcd/cli-utils#18

Merged

Uh oh!

Conversation

levenleven commented Dec 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

k8s-ci-robot commented Dec 24, 2023

Uh oh!

k8s-ci-robot commented Dec 24, 2023

Uh oh!

Uh oh!

k8s-triage-robot commented Mar 27, 2024

Uh oh!

karlkfi commented May 8, 2024

Uh oh!

karlkfi commented May 8, 2024

Uh oh!

levenleven commented May 9, 2024

Uh oh!

k8s-triage-robot commented Aug 7, 2024

Uh oh!

k8s-triage-robot commented Nov 5, 2024

Uh oh!

k8s-triage-robot commented Feb 3, 2025

Uh oh!

levenleven commented Feb 5, 2025

Uh oh!

Uh oh!

karlkfi Feb 6, 2025

Choose a reason for hiding this comment

Uh oh!

levenleven Jul 26, 2025

Choose a reason for hiding this comment

Uh oh!

k8s-triage-robot commented May 7, 2025

Uh oh!

karlkfi left a comment

Choose a reason for hiding this comment

Uh oh!

k8s-ci-robot commented Aug 31, 2025

Uh oh!

levenleven commented Sep 7, 2025

Uh oh!

karlkfi commented Sep 7, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

levenleven commented Dec 24, 2023 •

edited

Loading