Skip to content

Chores: Migrate deprecated wait.Poll* to context-aware equivalents. #13766

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

Merged

Conversation

oyiz-michael
Copy link
Contributor

@oyiz-michael oyiz-michael commented Aug 11, 2025

What this PR does / why we need it

Migrate all deprecated wait.Poll* usages to context-aware equivalents to remove deprecation warnings and align with current client-go patterns (maintenance scope per #13002). This improves timeout/cancellation handling and future-proofs the codebase without changing behavior.

Changes

  • wait.PollUntilwait.PollUntilContextCancel
  • wait.Poll / wait.PollImmediatewait.PollUntilContextTimeout
  • wait.ErrWaitTimeout checks → ctx.Err() == context.DeadlineExceeded
  • Thread contexts/timeouts consistently through polling call sites

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • CVE Report (Scanner found CVE and adding report)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation only

Which issue/s this PR fixes

N/A — proactive maintenance/refactor aligned with project status (#13002).

How Has This Been Tested?

  • go test ./... — all unit tests pass
  • Verified e2e polling paths compile and respect context timeouts/cancellation
  • Confirmed no behavioral changes: same polling intervals and exit conditions

Example migration

Before (deprecated):

err := wait.PollImmediate(1*time.Second, timeout, func() (bool, error) {
// ...
})
if err == wait.ErrWaitTimeout {
// handle timeout
}

After (context-aware):

ctx, cancel := context.WithTimeout(context.Background(), timeout)
defer cancel()

err := wait.PollUntilContextTimeout(ctx, 1*time.Second, timeout, true, func(ctx context.Context) (bool, error) {
// ...
})
if ctx.Err() == context.DeadlineExceeded {
// handle timeout
}

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have added unit and/or e2e tests to cover my changes.
  • All new and existing tests passed.

Copy link

netlify bot commented Aug 11, 2025

Deploy Preview for kubernetes-ingress-nginx canceled.

Name Link
🔨 Latest commit 7f53629
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-ingress-nginx/deploys/68a0c71a82b7ac00085ebb0e

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Aug 11, 2025
@k8s-ci-robot k8s-ci-robot requested a review from Gacko August 11, 2025 22:41
@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Aug 11, 2025
@k8s-ci-robot k8s-ci-robot added needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-priority labels Aug 11, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @oyiz-michael. 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 the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Aug 11, 2025
@oyiz-michael oyiz-michael force-pushed the chore/migrate-deprecated-wait-apis branch 3 times, most recently from 0c59de7 to 3619318 Compare August 12, 2025 07:16
@Gacko Gacko removed the request for review from tao12345666333 August 12, 2025 08:40
@Gacko Gacko self-assigned this Aug 12, 2025
@Gacko Gacko force-pushed the chore/migrate-deprecated-wait-apis branch from 3619318 to 7f53629 Compare August 16, 2025 17:59
Copy link
Member

@Gacko Gacko left a comment

Choose a reason for hiding this comment

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

/triage accepted
/kind cleanup
/priority backlog
/lgtm

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. priority/backlog Higher priority than priority/awaiting-more-evidence. lgtm "Looks good to me", indicates that a PR is ready to be merged. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-priority labels Aug 16, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Gacko, oyiz-michael

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 16, 2025
@Gacko
Copy link
Member

Gacko commented Aug 16, 2025

/cherry-pick release-1.13

@Gacko
Copy link
Member

Gacko commented Aug 16, 2025

/cherry-pick release-1.12

@k8s-infra-cherrypick-robot
Copy link
Contributor

@Gacko: once the present PR merges, I will cherry-pick it on top of release-1.13 in a new PR and assign it to you.

In response to this:

/cherry-pick release-1.13

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-infra-cherrypick-robot
Copy link
Contributor

@Gacko: once the present PR merges, I will cherry-pick it on top of release-1.12 in a new PR and assign it to you.

In response to this:

/cherry-pick release-1.12

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.

@Gacko Gacko changed the title chore: migrate deprecated wait.Poll* to context-aware equivalents Chores: Migrate deprecated wait.Poll* to context-aware equivalents. Aug 16, 2025
@Gacko
Copy link
Member

Gacko commented Aug 16, 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 Aug 16, 2025
@k8s-ci-robot k8s-ci-robot merged commit 02b3870 into kubernetes:main Aug 16, 2025
27 checks passed
@k8s-infra-cherrypick-robot
Copy link
Contributor

@Gacko: new pull request created: #13781

In response to this:

/cherry-pick release-1.13

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-infra-cherrypick-robot
Copy link
Contributor

@Gacko: new pull request created: #13782

In response to this:

/cherry-pick release-1.12

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.

@oyiz-michael
Copy link
Contributor Author

/assign

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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. 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. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. priority/backlog Higher priority than priority/awaiting-more-evidence. 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
Development

Successfully merging this pull request may close these issues.

4 participants