🐛 Error when source.Start() never returns #2997
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
| [APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: alvaroaleman 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 |
k8s-ci-robot added the cncf-cla: yes k8s-ci-robot added approved 
alvaroaleman force-pushed the start-take-two branch from 94029d0 to 5faad47 Compare 
Contrary to everything else in controller-runtime, we expect `source.Start` to be non-blocking. If someone implements a custom source and gets this wrong, the resulting behavior is that the binary starts successfully, but no reconciliation happens which is extremely difficult to understand and debug. This change makes us use the `CacheSyncTimeout` not only for the sources `WaitForSync` but also for its `Start`. It is worth noting that the current design of both requiring `Start` to not block and `WaitForSync` to block is very confusing. It likely came to be because we basicaly require two distinct contexsts in `Start`, one to indicate the lifetime of the `Source` and one to indicate the `Start` timeout. To overall simplify and improve the code, the change also parallelizes the `Start` of the sources.
alvaroaleman force-pushed the start-take-two branch from 5faad47 to 8cc205a Compare 
troy0820 reviewed Nov 8, 2024
| /lgtm |
k8s-ci-robot added the lgtm | LGTM label has been added. Git tree hash: f396e706f3c7a54b960ef9bc49e32407f4aa4b17 |
| Wasn't sure this would merge so quickly or else I would've put a hold on it to allow others to review. Do you want to cherry-pick this @alvaroaleman? |
No. No problem, it happens. I will do a follow-up regarding your comment and in case there are more comments |
alvaroaleman added a commit to alvaroaleman/controller-runtime that referenced this pull request Nov 8, 2024
Addresses kubernetes-sigs#2997 (comment), followup to kubernetes-sigs#2997
alvaroaleman added a commit to alvaroaleman/controller-runtime that referenced this pull request Nov 8, 2024
Addresses kubernetes-sigs#2997 (comment), followup to kubernetes-sigs#2997
sbueringer reviewed Nov 10, 2024
alvaroaleman added a commit to alvaroaleman/controller-runtime that referenced this pull request Nov 10, 2024
Addresses the comments on kubernetes-sigs#2997
alvaroaleman added a commit to alvaroaleman/controller-runtime that referenced this pull request Nov 10, 2024
Addresses the comments on kubernetes-sigs#2997
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
Contrary to everything else in controller-runtime, we expect
source.Startto be non-blocking. If someone implements a custom source and gets this wrong, the resulting behavior is that the binary starts successfully, but no reconciliation happens which is extremely difficult to understand and debug.This change makes us use the
CacheSyncTimeoutnot only for the sourcesWaitForSyncbut also for itsStart.It is worth noting that the current design of both requiring
Startto not block andWaitForSyncto block is very confusing. It likely came to be because we basicaly require two distinct contexsts inStart, one to indicate the lifetime of theSourceand one to indicate theStarttimeout.To overall simplify and improve the code, the change also parallelizes the
Startof the sources.